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",
}

Contains the parameters for DescribeNatGateways.

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

Returns:



9189
9190
9191
9192
9193
9194
9195
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9189

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

#max_resultsInteger

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

Returns:

  • (Integer)


9189
9190
9191
9192
9193
9194
9195
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9189

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


9189
9190
9191
9192
9193
9194
9195
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9189

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

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


9189
9190
9191
9192
9193
9194
9195
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9189

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