software.amazon.awssdk.services.ec2.model

Interface DescribeNatGatewaysRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeNatGatewaysRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeNatGatewaysRequest.Builder	filter(Collection<Filter> filter) One or more filters.
DescribeNatGatewaysRequest.Builder	filter(Consumer<Filter.Builder>... filter) One or more filters.
DescribeNatGatewaysRequest.Builder	filter(Filter... filter) One or more filters.
DescribeNatGatewaysRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return with a single call.
DescribeNatGatewaysRequest.Builder	natGatewayIds(Collection<String> natGatewayIds) One or more NAT gateway IDs.
DescribeNatGatewaysRequest.Builder	natGatewayIds(String... natGatewayIds) One or more NAT gateway IDs.
DescribeNatGatewaysRequest.Builder	nextToken(String nextToken) The token for the next page of results.
DescribeNatGatewaysRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeNatGatewaysRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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

filter

DescribeNatGatewaysRequest.Builder filter(Collection<Filter> filter)

One or more filters.

• nat-gateway-id - The ID of the NAT gateway.

• state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

• subnet-id - The ID of the subnet in which the NAT gateway resides.

• 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 in which the NAT gateway resides.

Parameters:

filter - One or more filters.

• nat-gateway-id - The ID of the NAT gateway.

• state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

• subnet-id - The ID of the subnet in which the NAT gateway resides.

• 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 in which the NAT gateway resides.

Returns:

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

filter

DescribeNatGatewaysRequest.Builder filter(Filter... filter)

One or more filters.

• nat-gateway-id - The ID of the NAT gateway.

• state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

• subnet-id - The ID of the subnet in which the NAT gateway resides.

• 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 in which the NAT gateway resides.

Parameters:

filter - One or more filters.

• nat-gateway-id - The ID of the NAT gateway.

• state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

• subnet-id - The ID of the subnet in which the NAT gateway resides.

• 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 in which the NAT gateway resides.

Returns:

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

filter

DescribeNatGatewaysRequest.Builder filter(Consumer<Filter.Builder>... filter)

One or more filters.

• nat-gateway-id - The ID of the NAT gateway.

• state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

• subnet-id - The ID of the subnet in which the NAT gateway resides.

• 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 in which the NAT gateway resides.

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filter(List).

Parameters:

filter - a consumer that will call methods on Filter.Builder

Returns:

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

See Also:

#filter(java.util.Collection)

maxResults

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

natGatewayIds

DescribeNatGatewaysRequest.Builder natGatewayIds(Collection<String> natGatewayIds)

One or more NAT gateway IDs.

Parameters:

natGatewayIds - One or more NAT gateway IDs.

Returns:

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

natGatewayIds

DescribeNatGatewaysRequest.Builder natGatewayIds(String... natGatewayIds)

One or more NAT gateway IDs.

Parameters:

natGatewayIds - One or more NAT gateway IDs.

Returns:

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

nextToken

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

overrideConfiguration

DescribeNatGatewaysRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder