You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeNatGatewaysRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeNatGatewaysRequest data as a hash:

{
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  nat_gateway_ids: ["String"],
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterArray<Types::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:



12815
12816
12817
12818
12819
12820
12821
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12815

class DescribeNatGatewaysRequest < Struct.new(
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

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:

  • (Integer)


12815
12816
12817
12818
12819
12820
12821
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12815

class DescribeNatGatewaysRequest < Struct.new(
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  include Aws::Structure
end

#nat_gateway_idsArray<String>

One or more NAT gateway IDs.

Returns:

  • (Array<String>)


12815
12816
12817
12818
12819
12820
12821
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12815

class DescribeNatGatewaysRequest < Struct.new(
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


12815
12816
12817
12818
12819
12820
12821
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12815

class DescribeNatGatewaysRequest < Struct.new(
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  include Aws::Structure
end