AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

Vpc

Define an AWS Virtual Private Cloud. See the package-level documentation of this package for an overview of the various dimensions in which you can configure your VPC. For example: ```ts const vpc = new ec2.Vpc(this, 'TheVPC', { ipAddresses: ec2.IpAddresses.cidr('10.0.0.0/16'), }) // Iterate the private subnets const selection = vpc.selectSubnets({ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }); for (const subnet of selection.subnets) { // ... } ```

Import

import { Vpc } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.Vpc

Properties

Configuration passed to the constructor as VpcProps.

availabilityZonesOptional
string[]

Availability zones this VPC spans. Specify this option only if you do not specify `maxAzs`.

Default: - a subset of AZs of the stack

cidrOptionalDeprecated
string

The CIDR range to use for the VPC, e.g. '10.0.0.0/16'. Should be a minimum of /28 and maximum size of /16. The range will be split across all subnets per Availability Zone.

Default: Vpc.DEFAULT_CIDR_RANGE

Deprecated: Use ipAddresses instead

createInternetGatewayOptional
boolean

If set to false then disable the creation of the default internet gateway.

Default: true

defaultInstanceTenancyOptional
DefaultInstanceTenancy

The default tenancy of instances launched into the VPC. By setting this to dedicated tenancy, instances will be launched on hardware dedicated to a single AWS customer, unless specifically specified at instance launch time. Please note, not all instance types are usable with Dedicated tenancy.

Default: DefaultInstanceTenancy.Default (shared) tenancy

enableDnsHostnamesOptional
boolean

Indicates whether the instances launched in the VPC get public DNS hostnames. If this attribute is true, instances in the VPC get public DNS hostnames, but only if the enableDnsSupport attribute is also set to true.

Default: true

enableDnsSupportOptional
boolean

Indicates whether the DNS resolution is supported for the VPC. If this attribute is false, the Amazon-provided DNS server in the VPC that resolves public DNS hostnames to IP addresses is not enabled. If this attribute is true, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC IPv4 network range plus two will succeed.

Default: true

flowLogsOptional
{ [key: string]: FlowLogOptions }

Flow logs to add to this VPC.

Default: - No flow logs.

gatewayEndpointsOptional
{ [key: string]: GatewayVpcEndpointOptions }

Gateway endpoints to add to this VPC.

Default: - None.

ipAddressesOptional
IIpAddresses

The Provider to use to allocate IPv4 Space to your VPC. Options include static allocation or from a pool. Note this is specific to IPv4 addresses.

Default: ec2.IpAddresses.cidr

ipProtocolOptional
IpProtocol

The protocol of the vpc. Options are IPv4 only or dual stack.

Default: IpProtocol.IPV4_ONLY

ipv6AddressesOptional
IIpv6Addresses

The Provider to use to allocate IPv6 Space to your VPC. Options include amazon provided CIDR block. Note this is specific to IPv6 addresses.

Default: Ipv6Addresses.amazonProvided

maxAzsOptional
number

Define the maximum number of AZs to use in this region. If the region has more AZs than you want to use (for example, because of EIP limits), pick a lower number here. The AZs will be sorted and picked from the start of the list. If you pick a higher number than the number of AZs in the region, all AZs in the region will be selected. To use "all AZs" available to your account, use a high number (such as 99). Be aware that environment-agnostic stacks will be created with access to only 2 AZs, so to use more than 2 AZs, be sure to specify the account and region on your stack. Specify this option only if you do not specify `availabilityZones`.

Default: 3

natGatewayProviderOptional
NatProvider

What type of NAT provider to use. Select between NAT gateways or NAT instances. NAT gateways may not be available in all AWS regions.

Default: NatProvider.gateway()

natGatewaysOptional
number

The number of NAT Gateways/Instances to create. The type of NAT gateway or instance will be determined by the `natGatewayProvider` parameter. You can set this number lower than the number of Availability Zones in your VPC in order to save on NAT cost. Be aware you may be charged for cross-AZ data traffic instead.

Default: - One NAT gateway/instance per Availability Zone

natGatewaySubnetsOptional
SubnetSelection

Configures the subnets which will have NAT Gateways/Instances. You can pick a specific group of subnets by specifying the group name; the picked subnets must be public subnets. Only necessary if you have more than one public subnet group.

Default: - All public subnets.

reservedAzsOptional
number

Define the number of AZs to reserve. When specified, the IP space is reserved for the azs but no actual resources are provisioned.

Default: 0

restrictDefaultSecurityGroupOptional
boolean

If set to true then the default inbound & outbound rules will be removed from the default security group.

Default: true if '@aws-cdk/aws-ec2:restrictDefaultSecurityGroup' is enabled, false otherwise

subnetConfigurationOptional
SubnetConfiguration[]

Configure the subnets to build for each AZ. Each entry in this list configures a Subnet Group; each group will contain a subnet for each Availability Zone. For example, if you want 1 public subnet, 1 private subnet, and 1 isolated subnet in each AZ provide the following: ```ts new ec2.Vpc(this, 'VPC', { subnetConfiguration: [ { cidrMask: 24, name: 'ingress', subnetType: ec2.SubnetType.PUBLIC, }, { cidrMask: 24, name: 'application', subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS, }, { cidrMask: 28, name: 'rds', subnetType: ec2.SubnetType.PRIVATE_ISOLATED, } ] }); ```

Default: - The VPC CIDR will be evenly divided between 1 public and 1 private subnet per AZ.

vpcNameOptional
string

The VPC name. Since the VPC resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag

Default: this.node.path

vpnConnectionsOptional
{ [key: string]: VpnConnectionOptions }

VPN connections to this VPC.

Default: - No connections.

vpnGatewayOptional
boolean

Indicates whether a VPN gateway should be created and attached to this VPC.

Default: - true when vpnGatewayAsn or vpnConnections is specified

vpnGatewayAsnOptional
number

The private Autonomous System Number (ASN) for the VPN gateway.

Default: - Amazon default ASN.

vpnRoutePropagationOptional
SubnetSelection[]

Where to propagate VPN routes.

Default: - On the route tables associated with private subnets. If no private subnets exists, isolated subnets are used. If no isolated subnets exists, public subnets are used.

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic