Class: Aws::EC2::Types::CreateNatGatewayRequest

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 CreateNatGatewayRequest data as a hash:

{
  allocation_id: "AllocationId", # required
  client_token: "String",
  dry_run: false,
  subnet_id: "SubnetId", # required
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_idString

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

Returns:

  • (String)


6928
6929
6930
6931
6932
6933
6934
6935
6936
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6928

class CreateNatGatewayRequest < Struct.new(
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


6928
6929
6930
6931
6932
6933
6934
6935
6936
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6928

class CreateNatGatewayRequest < Struct.new(
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

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


6928
6929
6930
6931
6932
6933
6934
6935
6936
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6928

class CreateNatGatewayRequest < Struct.new(
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idString

The subnet in which to create the NAT gateway.

Returns:

  • (String)


6928
6929
6930
6931
6932
6933
6934
6935
6936
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6928

class CreateNatGatewayRequest < Struct.new(
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to assign to the NAT gateway.

Returns:



6928
6929
6930
6931
6932
6933
6934
6935
6936
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6928

class CreateNatGatewayRequest < Struct.new(
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end