> **Experimental**
>
> `@aws-cdk/aws-ec2-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# NatGateway

Creates a network address translation (NAT) gateway.

Extends: Construct › Resource › NatGateway
Implements: IRouteTarget, IResource, IEnvironmentAware, IConstruct, IDependable

- Stability: [Experimental](/cdk/api/stability.html)
- CloudFormation: [`AWS::EC2::NatGateway`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-ec2-natgateway.html)
- L1 type: [`CfnNatGateway`](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnNatGateway.html)
- Source: [`lib/route.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-ec2-alpha/lib/route.ts#L411)

## Example

```ts
const myVpc = new VpcV2(this, 'Vpc');
const routeTable = new RouteTable(this, 'RouteTable', {
  vpc: myVpc,
});
const subnet = new SubnetV2(this, 'Subnet', {
  vpc: myVpc,
  availabilityZone: 'eu-west-2a',
  ipv4CidrBlock: new IpCidr('10.0.0.0/24'),
  subnetType: SubnetType.PRIVATE_ISOLATED });

const natgw = new NatGateway(this, 'NatGW', {
  subnet: subnet,
  vpc: myVpc,
  connectivityType: NatConnectivityType.PRIVATE,
  privateIpAddress: '10.0.0.42',
});
new Route(this, 'NatGwRoute', {
  routeTable,
  destination: '0.0.0.0/0',
  target: { gateway: natgw },
});
```

## Initializer

```ts
new NatGateway(scope: Construct, id: string, props: NatGatewayProps)
```

## Construct Props

- `allocationId`: string — AllocationID of Elastic IP address that's associated with the NAT gateway.

  **Default:** attr.allocationID of a new Elastic IP created by default //TODO: ADD L2 for elastic ip

  This property is required for a public NAT
  gateway and cannot be specified with a private NAT gateway.

- `connectivityType`: [NatConnectivityType](/cdk/api/v2/docs/@aws-cdk_aws-ec2-alpha.NatConnectivityType.html) = NatConnectivityType.Public — Indicates whether the NAT gateway supports public or private connectivity.

- `maxDrainDuration`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.seconds(350) — The maximum amount of time to wait before forcibly releasing the IP addresses if connections are still in progress.

- `natGatewayName`: string — The resource name of the NAT gateway.

  **Default:** NATGW provisioned without any name

- `privateIpAddress`: string — The private IPv4 address to assign to the NAT gateway.

  **Default:** If you don't provide an address, a private IPv4 address will be automatically assigned.

- `secondaryAllocationIds`: string[] — Secondary EIP allocation IDs.

  **Default:** no secondary allocation IDs attached to NATGW

- `secondaryPrivateIpAddressCount`: number — The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

  **Default:** no secondary allocation IDs associated with NATGW

  `SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be
  set at the same time.

- `secondaryPrivateIpAddresses`: string[] — Secondary private IPv4 addresses.

  **Default:** no secondary private IpAddresses associated with NATGW

  `SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be
  set at the same time.

- `subnet`: [ISubnetV2](/cdk/api/v2/docs/@aws-cdk_aws-ec2-alpha.ISubnetV2.html) (required) — The subnet in which the NAT gateway is located.

- `vpc`: [IVpcV2](/cdk/api/v2/docs/@aws-cdk_aws-ec2-alpha.IVpcV2.html) — The ID of the VPC in which the NAT gateway is located.

  **Default:** no elastic ip associated, required in case of public connectivity if `AllocationId` is not defined

## Properties

- `connectivityType`: [NatConnectivityType](/cdk/api/v2/docs/@aws-cdk_aws-ec2-alpha.NatConnectivityType.html) = public — Indicates whether the NAT gateway supports public or private connectivity.

- `eip`: [CfnEIP](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnEIP.html) — Elastic IP created for allocation.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `maxDrainDuration`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — The maximum amount of time to wait before forcibly releasing the IP addresses if connections are still in progress.

  **Default:** '350 seconds'

- `natGatewayId`: string — Id of the NatGateway.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `resource`: [CfnNatGateway](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnNatGateway.html) — The NAT gateway CFN resource.

- `routerTargetId`: string — The ID of the route target.

- `routerType`: [RouterType](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.RouterType.html) — The type of router used in the route.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.