Class DescribeSubnetsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.ec2.model.DescribeSubnetsRequest
All Implemented Interfaces:
ReadLimitInfo, DryRunSupportedRequest<DescribeSubnetsRequest>, Serializable, Cloneable

public class DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeSubnetsRequest>

Contains the parameters for DescribeSubnets.

See Also:
  • Constructor Details

    • DescribeSubnetsRequest

      public DescribeSubnetsRequest()
  • Method Details

    • getSubnetIds

      public List<String> getSubnetIds()

      One or more subnet IDs.

      Default: Describes all your subnets.

      Returns:
      One or more subnet IDs.

      Default: Describes all your subnets.

    • setSubnetIds

      public void setSubnetIds(Collection<String> subnetIds)

      One or more subnet IDs.

      Default: Describes all your subnets.

      Parameters:
      subnetIds - One or more subnet IDs.

      Default: Describes all your subnets.

    • withSubnetIds

      public DescribeSubnetsRequest withSubnetIds(String... subnetIds)

      One or more subnet IDs.

      Default: Describes all your subnets.

      NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

      Parameters:
      subnetIds - One or more subnet IDs.

      Default: Describes all your subnets.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withSubnetIds

      public DescribeSubnetsRequest withSubnetIds(Collection<String> subnetIds)

      One or more subnet IDs.

      Default: Describes all your subnets.

      Parameters:
      subnetIds - One or more subnet IDs.

      Default: Describes all your subnets.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getFilters

      public List<Filter> getFilters()

      One or more filters.

      • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

      • available-ip-address-count - The number of IP addresses in the subnet that are available.

      • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

      • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

      • state - The state of the subnet (pending | available).

      • subnet-id - The ID of the subnet.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • vpc-id - The ID of the VPC for the subnet.

      Returns:
      One or more filters.

      • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

      • available-ip-address-count - The number of IP addresses in the subnet that are available.

      • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

      • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

      • state - The state of the subnet ( pending | available).

      • subnet-id - The ID of the subnet.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • vpc-id - The ID of the VPC for the subnet.

    • setFilters

      public void setFilters(Collection<Filter> filters)

      One or more filters.

      • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

      • available-ip-address-count - The number of IP addresses in the subnet that are available.

      • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

      • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

      • state - The state of the subnet (pending | available).

      • subnet-id - The ID of the subnet.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • vpc-id - The ID of the VPC for the subnet.

      Parameters:
      filters - One or more filters.

      • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

      • available-ip-address-count - The number of IP addresses in the subnet that are available.

      • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

      • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

      • state - The state of the subnet (pending | available).

      • subnet-id - The ID of the subnet.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • vpc-id - The ID of the VPC for the subnet.

    • withFilters

      public DescribeSubnetsRequest withFilters(Filter... filters)

      One or more filters.

      • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

      • available-ip-address-count - The number of IP addresses in the subnet that are available.

      • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

      • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

      • state - The state of the subnet (pending | available).

      • subnet-id - The ID of the subnet.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • vpc-id - The ID of the VPC for the subnet.

      NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

      Parameters:
      filters - One or more filters.

      • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

      • available-ip-address-count - The number of IP addresses in the subnet that are available.

      • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

      • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

      • state - The state of the subnet (pending | available).

      • subnet-id - The ID of the subnet.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • vpc-id - The ID of the VPC for the subnet.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withFilters

      public DescribeSubnetsRequest withFilters(Collection<Filter> filters)

      One or more filters.

      • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

      • available-ip-address-count - The number of IP addresses in the subnet that are available.

      • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

      • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

      • state - The state of the subnet (pending | available).

      • subnet-id - The ID of the subnet.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • vpc-id - The ID of the VPC for the subnet.

      Parameters:
      filters - One or more filters.

      • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

      • available-ip-address-count - The number of IP addresses in the subnet that are available.

      • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

      • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

      • state - The state of the subnet (pending | available).

      • subnet-id - The ID of the subnet.

      • tag:key=value - The key/value combination of a tag assigned to the resource.

      • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key=value filter.

      • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

      • vpc-id - The ID of the VPC for the subnet.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getDryRunRequest

      public Request<DescribeSubnetsRequest> getDryRunRequest()
      This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
      Specified by:
      getDryRunRequest in interface DryRunSupportedRequest<DescribeSubnetsRequest>
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeSubnetsRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: