com.amazonaws.services.ec2.model

Class DescribeSubnetsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSubnetsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeSubnetsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSubnetsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeSubnetsRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeSubnetsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeSubnetsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<DescribeSubnetsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
Integer	getMaxResults() The maximum number of results to return with a single call.
String	getNextToken() The token for the next page of results.
List<String>	getSubnetIds() One or more subnet IDs.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setMaxResults(Integer maxResults) The maximum number of results to return with a single call.
void	setNextToken(String nextToken) The token for the next page of results.
void	setSubnetIds(Collection<String> subnetIds) One or more subnet IDs.
String	toString() Returns a string representation of this object.
DescribeSubnetsRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeSubnetsRequest	withFilters(Filter... filters) One or more filters.
DescribeSubnetsRequest	withMaxResults(Integer maxResults) The maximum number of results to return with a single call.
DescribeSubnetsRequest	withNextToken(String nextToken) The token for the next page of results.
DescribeSubnetsRequest	withSubnetIds(Collection<String> subnetIds) One or more subnet IDs.
DescribeSubnetsRequest	withSubnetIds(String... subnetIds) One or more subnet IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSubnetsRequest

public DescribeSubnetsRequest()

Method Detail

getFilters

public List<Filter> getFilters()

One or more filters.

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

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

• cidr-block - The IPv4 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 cidrBlock as the filter names.

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

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the AWS account that owns the subnet.

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

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Returns:

One or more filters.

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

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

• cidr-block - The IPv4 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 cidrBlock as the filter names.

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

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the AWS account that owns the subnet.

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

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

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

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

• cidr-block - The IPv4 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 cidrBlock as the filter names.

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

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the AWS account that owns the subnet.

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

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Parameters:

filters - One or more filters.

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

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

• cidr-block - The IPv4 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 cidrBlock as the filter names.

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

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the AWS account that owns the subnet.

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

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

withFilters

public DescribeSubnetsRequest withFilters(Filter... filters)

One or more filters.

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

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

• cidr-block - The IPv4 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 cidrBlock as the filter names.

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

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the AWS account that owns the subnet.

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

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• 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.

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

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

• cidr-block - The IPv4 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 cidrBlock as the filter names.

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

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the AWS account that owns the subnet.

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

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• 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.

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

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

• cidr-block - The IPv4 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 cidrBlock as the filter names.

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

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the AWS account that owns the subnet.

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

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Parameters:

filters - One or more filters.

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

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

• cidr-block - The IPv4 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 cidrBlock as the filter names.

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

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the AWS account that owns the subnet.

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

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• 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.

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.

setNextToken

public void setNextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

getNextToken

public String getNextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

withNextToken

public DescribeSubnetsRequest withNextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Parameters:

maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

withMaxResults

public DescribeSubnetsRequest withMaxResults(Integer maxResults)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Parameters:

maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

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 object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()