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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateNatGatewayRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allocation_id ⇒ String

  [Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway.

• #availability_mode ⇒ String

  Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

• #availability_zone_addresses ⇒ Array<Types::AvailabilityZoneAddress>

  For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ.

• #client_token ⇒ String

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #connectivity_type ⇒ String

  Indicates whether the NAT gateway supports public or private connectivity.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #private_ip_address ⇒ String

  The private IPv4 address to assign to the NAT gateway.

• #secondary_allocation_ids ⇒ Array<String>

  Secondary EIP allocation IDs.

• #secondary_private_ip_address_count ⇒ Integer

  [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

• #secondary_private_ip_addresses ⇒ Array<String>

  Secondary private IPv4 addresses.

• #subnet_id ⇒ String

  The ID of the subnet in which to create the NAT gateway.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to assign to the NAT gateway.

• #vpc_id ⇒ String

  The ID of the VPC where you want to create a regional NAT gateway.

Instance Attribute Details

#allocation_id ⇒ String

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

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#availability_mode ⇒ String

Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Defaults to ‘zonal`.

A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see [Regional NAT gateways for automatic multi-AZ expansion] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_addresses ⇒ Array<Types::AvailabilityZoneAddress>

For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ. The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage.

A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

For more information, see [Regional NAT gateways for automatic multi-AZ expansion] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html

Returns:

• (Array<Types::AvailabilityZoneAddress>)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency].

Constraint: Maximum 64 ASCII characters.

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

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#connectivity_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#private_ip_address ⇒ String

The private IPv4 address to assign to the NAT gateway. If you don’t provide an address, a private IPv4 address will be automatically assigned.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_allocation_ids ⇒ Array<String>

Secondary EIP allocation IDs. For more information, see [Create a NAT gateway] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_private_ip_address_count ⇒ Integer

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_private_ip_addresses ⇒ Array<String>

Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_id ⇒ String

The ID of the subnet in which to create the NAT gateway.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to assign to the NAT gateway.

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The ID of the VPC where you want to create a regional NAT gateway.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12660

class CreateNatGatewayRequest < Struct.new(
  :availability_mode,
  :allocation_id,
  :client_token,
  :dry_run,
  :subnet_id,
  :vpc_id,
  :availability_zone_addresses,
  :tag_specifications,
  :connectivity_type,
  :private_ip_address,
  :secondary_allocation_ids,
  :secondary_private_ip_addresses,
  :secondary_private_ip_address_count)
  SENSITIVE = []
  include Aws::Structure
end