Interface INatGatewayConfig

NetworkConfig / VpcConfig | VpcTemplatesConfig / NatGatewayConfig

Network Address Translation (NAT) Gateway configuration.

Description

Use this configuration to define AWS-managed NAT Gateways for your VPC. You can use a NAT gateway so that instances in a private subnet can connect to services outside your VPCs.

Example

NAT gateway with accelerator-provisioned elastic IP

- name: accelerator-nat-gw
  subnet: accelerator-cidr-subnet-a
  tags: []

NAT gateway with user-provided elastic IP allocation ID

- name: accelerator-nat-gw
  allocationId: eipalloc-acbdefg123456
  subnet: accelerator-cidr-subnet-a
  tags: []

NAT gateway with private connectivity

- name: accelerator-nat-gw
  private: true
  subnet: accelerator-cidr-subnet-a
  tags: []
interface INatGatewayConfig {
    allocationId?: string;
    name: string;
    private?: boolean;
    subnet: string;
    tags?: ITag[];
}

Properties

allocationId? name private? subnet tags?

Properties

Optional ReadonlyallocationId

allocationId?: string

(OPTIONAL) The allocation ID of the Elastic IP address that's associated with the NAT gateway. This allocation ID must exist in the target account the NAT gateway is deployed to.

Remarks

CAUTION: changing this property after initial deployment will cause a NAT gateway recreation. Please be aware that any downstream dependencies may cause this property update to fail.

NOTE: Leaving this property undefined results in the accelerator provisioning a new elastic IP.

To retrieve the allocationId of your Elastic IP address, perform the following:

  1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/.
  2. In the navigation pane, choose Elastic IPs.
  3. Select the Elastic IP address and reference the value in the Allocation ID column. The format should be eipalloc-abc123xyz.

Readonlyname

name: string

A friendly name for the NAT Gateway.

Remarks

CAUTION: changing this property after initial deployment will cause a NAT gateway recreation. Please be aware that any downstream dependencies may cause this property update to fail.

Optional Readonlyprivate

private?: boolean

(OPTIONAL) Set true to define a NAT gateway with private connectivity type

Remarks

CAUTION: changing this property after initial deployment will cause a NAT gateway recreation. Please be aware that any downstream dependencies may cause this property update to fail.

Set to false or leave undefined to create a public-facing NAT gateway

Readonlysubnet

subnet: string

The friendly name of the subnet for the NAT Gateway to be deployed.

Remarks

CAUTION: changing this property after initial deployment will cause a NAT gateway recreation. Please be aware that any downstream dependencies may cause this property update to fail.

Optional Readonlytags

tags?: ITag[]

(OPTIONAL) An array of tag objects for the NAT Gateway.

Settings

Member Visibility

On This Page

Properties