software.amazon.awssdk.services.ec2.model

Interface DescribeSubnetsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeSubnetsRequest.Builder,DescribeSubnetsRequest>, Ec2Request.Builder, SdkBuilder<DescribeSubnetsRequest.Builder,DescribeSubnetsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeSubnetsRequest

public static interface DescribeSubnetsRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeSubnetsRequest.Builder,DescribeSubnetsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeSubnetsRequest.Builder	filters(Collection<Filter> filters) One or more filters.
DescribeSubnetsRequest.Builder	filters(Consumer<Filter.Builder>... filters) One or more filters.
DescribeSubnetsRequest.Builder	filters(Filter... filters) One or more filters.
DescribeSubnetsRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return with a single call.
DescribeSubnetsRequest.Builder	nextToken(String nextToken) The token for the next page of results.
DescribeSubnetsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeSubnetsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DescribeSubnetsRequest.Builder	subnetIds(Collection<String> subnetIds) One or more subnet IDs.
DescribeSubnetsRequest.Builder	subnetIds(String... subnetIds) One or more subnet IDs.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

filters

DescribeSubnetsRequest.Builder filters(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.

filters

DescribeSubnetsRequest.Builder filters(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.

filters

DescribeSubnetsRequest.Builder filters(Consumer<Filter.Builder>... 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

subnetIds

DescribeSubnetsRequest.Builder subnetIds(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.

subnetIds

DescribeSubnetsRequest.Builder subnetIds(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.

nextToken

DescribeSubnetsRequest.Builder nextToken(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.

maxResults

DescribeSubnetsRequest.Builder maxResults(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.

overrideConfiguration

DescribeSubnetsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DescribeSubnetsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.