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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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:

  • (Boolean)


22162
22163
22164
22165
22166
22167
22168
22169
22170
# File 'lib/aws-sdk-ec2/types.rb', line 22162

class DescribeNatGatewaysRequest < Struct.new(
  :dry_run,
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filterArray<Types::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`:&lt;key&gt; - 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:



22162
22163
22164
22165
22166
22167
22168
22169
22170
# File 'lib/aws-sdk-ec2/types.rb', line 22162

class DescribeNatGatewaysRequest < Struct.new(
  :dry_run,
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

  • (Integer)


22162
22163
22164
22165
22166
22167
22168
22169
22170
# File 'lib/aws-sdk-ec2/types.rb', line 22162

class DescribeNatGatewaysRequest < Struct.new(
  :dry_run,
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#nat_gateway_idsArray<String>

The IDs of the NAT gateways.

Returns:

  • (Array<String>)


22162
22163
22164
22165
22166
22167
22168
22169
22170
# File 'lib/aws-sdk-ec2/types.rb', line 22162

class DescribeNatGatewaysRequest < Struct.new(
  :dry_run,
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


22162
22163
22164
22165
22166
22167
22168
22169
22170
# File 'lib/aws-sdk-ec2/types.rb', line 22162

class DescribeNatGatewaysRequest < Struct.new(
  :dry_run,
  :filter,
  :max_results,
  :nat_gateway_ids,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end