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:

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

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)


17882
17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17882

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

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



17882
17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17882

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 results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

  • (Integer)


17882
17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17882

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

#nat_gateway_idsArray<String>

One or more NAT gateway IDs.

Returns:

  • (Array<String>)


17882
17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17882

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

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


17882
17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17882

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