Package 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 Details

    • dryRun

      DescribeNatGatewaysRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      DescribeNatGatewaysRequest.Builder filter(Collection<Filter> filter)

      The 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 - The 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)

      The 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 - The 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)

      The 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<Filter>).

      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:

    • maxResults

      DescribeNatGatewaysRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

      Parameters:
      maxResults - The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • natGatewayIds

      DescribeNatGatewaysRequest.Builder natGatewayIds(Collection<String> natGatewayIds)

      The IDs of the NAT gateways.

      Parameters:
      natGatewayIds - The IDs of the NAT gateways.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • natGatewayIds

      DescribeNatGatewaysRequest.Builder natGatewayIds(String... natGatewayIds)

      The IDs of the NAT gateways.

      Parameters:
      natGatewayIds - The IDs of the NAT gateways.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeNatGatewaysRequest.Builder nextToken(String nextToken)

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

      Parameters:
      nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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