Skip to content

Create Nat Gateway

ec2_create_nat_gateway R Documentation

Creates a NAT gateway in the specified subnet

Description

Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.

With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.

With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.

For more information, see NAT gateways in the Amazon VPC User Guide.

When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.

Usage

ec2_create_nat_gateway(AvailabilityMode, AllocationId, ClientToken,
  DryRun, SubnetId, VpcId, AvailabilityZoneAddresses, TagSpecifications,
  ConnectivityType, PrivateIpAddress, SecondaryAllocationIds,
  SecondaryPrivateIpAddresses, SecondaryPrivateIpAddressCount)

Arguments

AvailabilityMode

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

[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.
ClientToken

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

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

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

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

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

The tags to assign to the NAT gateway.
ConnectivityType

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

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

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

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

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

Value

A list with the following syntax:

list(
  ClientToken = "string",
  NatGateway = list(
    CreateTime = as.POSIXct(
      "2015-01-01"
    ),
    DeleteTime = as.POSIXct(
      "2015-01-01"
    ),
    FailureCode = "string",
    FailureMessage = "string",
    NatGatewayAddresses = list(
      list(
        AllocationId = "string",
        NetworkInterfaceId = "string",
        PrivateIp = "string",
        PublicIp = "string",
        AssociationId = "string",
        IsPrimary = TRUE|FALSE,
        FailureMessage = "string",
        Status = "assigning"|"unassigning"|"associating"|"disassociating"|"succeeded"|"failed",
        AvailabilityZone = "string",
        AvailabilityZoneId = "string"
      )
    ),
    NatGatewayId = "string",
    ProvisionedBandwidth = list(
      ProvisionTime = as.POSIXct(
        "2015-01-01"
      ),
      Provisioned = "string",
      RequestTime = as.POSIXct(
        "2015-01-01"
      ),
      Requested = "string",
      Status = "string"
    ),
    State = "pending"|"failed"|"available"|"deleting"|"deleted",
    SubnetId = "string",
    VpcId = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    ConnectivityType = "private"|"public",
    AvailabilityMode = "zonal"|"regional",
    AutoScalingIps = "enabled"|"disabled",
    AutoProvisionZones = "enabled"|"disabled",
    AttachedAppliances = list(
      list(
        Type = "network-firewall-proxy",
        ApplianceArn = "string",
        VpcEndpointId = "string",
        AttachmentState = "attaching"|"attached"|"detaching"|"detached"|"attach-failed"|"detach-failed",
        ModificationState = "modifying"|"completed"|"failed",
        FailureCode = "string",
        FailureMessage = "string"
      )
    ),
    RouteTableId = "string"
  )
)

Request syntax

svc$create_nat_gateway(
  AvailabilityMode = "zonal"|"regional",
  AllocationId = "string",
  ClientToken = "string",
  DryRun = TRUE|FALSE,
  SubnetId = "string",
  VpcId = "string",
  AvailabilityZoneAddresses = list(
    list(
      AvailabilityZone = "string",
      AvailabilityZoneId = "string",
      AllocationIds = list(
        "string"
      )
    )
  ),
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"image-usage-report"|"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"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-metering-policy"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"vpc-encryption-control"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-policy"|"ipam-prefix-list-resolver-target"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator"|"ipam-pool-allocation",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  ConnectivityType = "private"|"public",
  PrivateIpAddress = "string",
  SecondaryAllocationIds = list(
    "string"
  ),
  SecondaryPrivateIpAddresses = list(
    "string"
  ),
  SecondaryPrivateIpAddressCount = 123
)

Examples

## Not run: 
# This example creates a NAT gateway in subnet subnet-1a2b3c4d and
# associates an Elastic IP address with the allocation ID
# eipalloc-37fc1a52 with the NAT gateway.
svc$create_nat_gateway(
  AllocationId = "eipalloc-37fc1a52",
  SubnetId = "subnet-1a2b3c4d"
)

## End(Not run)