com.amazonaws.services.ec2.model

Class DescribeSubnetsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSubnetsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeSubnetsRequest>, java.io.Serializable, java.lang.Cloneable

public class DescribeSubnetsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeSubnetsRequest>

Container for the parameters to the DescribeSubnets operation.

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .

See Also:

AmazonEC2.describeSubnets(DescribeSubnetsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeSubnetsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Request<DescribeSubnetsRequest>	getDryRunRequest() This method is intended for internal use only.
java.util.List<Filter>	getFilters() One or more filters.
java.util.List<java.lang.String>	getSubnetIds() One or more subnet IDs.
int	hashCode()
void	setFilters(java.util.Collection<Filter> filters) One or more filters.
void	setSubnetIds(java.util.Collection<java.lang.String> subnetIds) One or more subnet IDs.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeSubnetsRequest	withFilters(java.util.Collection<Filter> filters) One or more filters.
DescribeSubnetsRequest	withFilters(Filter... filters) One or more filters.
DescribeSubnetsRequest	withSubnetIds(java.util.Collection<java.lang.String> subnetIds) One or more subnet IDs.
DescribeSubnetsRequest	withSubnetIds(java.lang.String... subnetIds) One or more subnet IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSubnetsRequest

public DescribeSubnetsRequest()

Method Detail

getSubnetIds

public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.String... subnetIds)

One or more subnet IDs.

Default: Describes all your subnets.

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

Parameters:

subnetIds - One or more subnet IDs.

Default: Describes all your subnets.

Returns:

A reference to this updated object so that method calls can be chained together.

withSubnetIds

public DescribeSubnetsRequest withSubnetIds(java.util.Collection<java.lang.String> subnetIds)

One or more subnet IDs.

Default: Describes all your subnets.

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

Parameters:

subnetIds - One or more subnet IDs.

Default: Describes all your subnets.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public java.util.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(java.util.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.

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

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:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeSubnetsRequest withFilters(java.util.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.

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

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:

A reference to this updated 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 java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object