interface CfnVPCProps

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.CfnVPCProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnVPCProps`
Java	`software.amazon.awscdk.services.ec2.CfnVPCProps`
Python	`aws_cdk.aws_ec2.CfnVPCProps`
TypeScript	`aws-cdk-lib` » `aws_ec2` » `CfnVPCProps`

Properties for defining a CfnVPC.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnVPCProps: ec2.CfnVPCProps = {
  cidrBlock: 'cidrBlock',
  enableDnsHostnames: false,
  enableDnsSupport: false,
  instanceTenancy: 'instanceTenancy',
  ipv4IpamPoolId: 'ipv4IpamPoolId',
  ipv4NetmaskLength: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
cidrBlock?	`string`	The IPv4 network range for the VPC, in CIDR notation.
enableDnsHostnames?	`boolean \|` `IResolvable`	Indicates whether the instances launched in the VPC get DNS hostnames.
enableDnsSupport?	`boolean \|` `IResolvable`	Indicates whether the DNS resolution is supported for the VPC.
instanceTenancy?	`string`	The allowed tenancy of instances launched into the VPC.
ipv4IpamPoolId?	`string`	The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.
ipv4NetmaskLength?	`number`	The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.
tags?	`CfnTag[]`	The tags for the VPC.

cidrBlock?

Type: string (optional)

The IPv4 network range for the VPC, in CIDR notation.

For example, 10.0.0.0/16 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .

You must specify either CidrBlock or Ipv4IpamPoolId .

enableDnsHostnames?

Type: boolean | IResolvable (optional)

Indicates whether the instances launched in the VPC get DNS hostnames.

If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see DNS attributes in your VPC .

You can only enable DNS hostnames if you've enabled DNS support.

enableDnsSupport?

Type: boolean | IResolvable (optional)

Indicates whether the DNS resolution is supported for the VPC.

If enabled, 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 network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see DNS attributes in your VPC .

instanceTenancy?

Type: string (optional)

The allowed tenancy of instances launched into the VPC.

default : An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
dedicated : An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.

Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default . Updating InstanceTenancy from default to dedicated requires replacement.

ipv4IpamPoolId?

Type: string (optional)

The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

You must specify either CidrBlock or Ipv4IpamPoolId .

ipv4NetmaskLength?

Type: number (optional)

The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide .

tags?

Type: CfnTag[] (optional)

The tags for the VPC.