Package software.amazon.awssdk.services.ec2.model

Class DescribeSubnetsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ec2.model.DescribeSubnetsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeSubnetsRequest.Builder,DescribeSubnetsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeSubnetsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeSubnetsRequest.Builder,DescribeSubnetsRequest>

Contains the parameters for DescribeSubnets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSubnetsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeSubnetsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters()	One or more filters.
int	hashCode()
static Class<? extends DescribeSubnetsRequest.Builder>	serializableBuilderClass()
List<String>	subnetIds()	One or more subnet IDs.
DescribeSubnetsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

filters

public List<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 IPv4 addresses in the subnet that are available.

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

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

• 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. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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 IPv4 addresses in the subnet that are available.

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

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

• 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. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

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

subnetIds

public List<String> subnetIds()

One or more subnet IDs.

Default: Describes all your subnets.

Returns:

One or more subnet IDs.

Default: Describes all your subnets.

toBuilder

public DescribeSubnetsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSubnetsRequest.Builder,DescribeSubnetsRequest>

Returns:

a builder for type T

builder

public static DescribeSubnetsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSubnetsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object