2.272.0

interface RegionalNatGatewayProviderProps

LanguageType name
.NETAmazon.CDK.AWS.EC2.RegionalNatGatewayProviderProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#RegionalNatGatewayProviderProps
Javasoftware.amazon.awscdk.services.ec2.RegionalNatGatewayProviderProps
Pythonaws_cdk.aws_ec2.RegionalNatGatewayProviderProps
TypeScript (source)aws-cdk-lib » aws_ec2 » RegionalNatGatewayProviderProps

Properties for a Regional NAT Gateway Provider.

Regional NAT Gateways provide automatic multi-AZ redundancy with a single gateway that scales across availability zones.

Example

const eip = new ec2.CfnEIP(this, 'NatEip');

new ec2.Vpc(this, 'Vpc1', {
  natGatewayProvider: ec2.NatProvider.regionalGateway({
    eip,
  }),
});

new ec2.Vpc(this, 'Vpc2', {
  natGatewayProvider: ec2.NatProvider.regionalGateway({
    allocationId: eip.attrAllocationId,
  }),
});

Properties

NameTypeDescription
allocationId?stringThe allocation ID of the Elastic IP address to use for this NAT gateway.
availabilityZoneAddresses?AvailabilityZoneAddress[]Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses to use in each AZ.
eip?IEIPRefReference to an existing EIP to use for this NAT gateway.
maxDrainDuration?DurationMaximum amount of time to wait before forcibly releasing IP addresses if connections are still in progress.

allocationId?

Type: string (optional, default: A new EIP is automatically allocated)

The allocation ID of the Elastic IP address to use for this NAT gateway.

Cannot be specified together with eip. Ignored when availabilityZoneAddresses is specified.

availabilityZoneAddresses?

Type: AvailabilityZoneAddress[] (optional, default: Automatic mode: AWS manages AZ coverage and EIP allocation)

Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses to use in each AZ.

When specified, allocationId and eip are ignored. This enables manual mode for Regional NAT Gateway where you control EIP allocation per AZ.

In manual mode the gateway only serves the listed Availability Zones and does not expand to other zones automatically, so every Availability Zone that contains a private subnet routed through this gateway must be listed. When the zone names are known at synthesis time, a private subnet in an unlisted zone is rejected with an error. Entries that use availabilityZoneId or unresolved tokens cannot be checked and are assumed to be correct.

eip?

Type: IEIPRef (optional, default: A new EIP is automatically allocated)

Reference to an existing EIP to use for this NAT gateway.

Cannot be specified together with allocationId. Ignored when availabilityZoneAddresses is specified.

maxDrainDuration?

Type: Duration (optional, default: Duration.seconds(350))

Maximum amount of time to wait before forcibly releasing IP addresses if connections are still in progress.

← PreviousNext →