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",
  client_token: "String",
  dry_run: false,
  subnet_id: "SubnetId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  connectivity_type: "private", # accepts private, public
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_idString

[Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

Returns:

  • (String)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9753

class CreateNatGatewayRequest < Struct.new(
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :tag_specifications,
  :connectivity_type)
  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)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9753

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

#connectivity_typeString

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

Returns:

  • (String)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9753

class CreateNatGatewayRequest < Struct.new(
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :tag_specifications,
  :connectivity_type)
  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)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9753

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

#subnet_idString

The subnet in which to create the NAT gateway.

Returns:

  • (String)


9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9753

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

#tag_specificationsArray<Types::TagSpecification>

The tags to assign to the NAT gateway.

Returns:



9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9753

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