AWS CDK Reference

Appearance

v2.275.0

VpcAttributes Struct ​

Properties that reference an external Vpc.

Source
aws-ec2/lib/vpc.ts
Type last changed
v2.60.0 · 12 Jan 2023

Example ​

ts
const vpc = ec2.Vpc.fromVpcAttributes(this, 'VPC', {
  vpcId: 'vpc-1234',
  availabilityZones: ['us-east-1a', 'us-east-1b'],

  // Either pass literals for all IDs
  publicSubnetIds: ['s-12345', 's-67890'],

  // OR: import a list of known length
  privateSubnetIds: Fn.importListValue('PrivateSubnetIds', 2),

  // OR: split an imported string to a list of known length
  isolatedSubnetIds: Fn.split(',', ssm.StringParameter.valueForStringParameter(this, `MyParameter`), 2),
});

Properties ​

availabilityZonesstring[]availability_zonestyping.List[str]availabilityZonesList<String>AvailabilityZonesstring[]AvailabilityZones*[]*stringrequired#
List of availability zones for the subnets in this VPC.
isolatedSubnetIdsoptionalstring[]isolated_subnet_idsoptionaltyping.List[str]isolatedSubnetIdsoptionalList<String>IsolatedSubnetIdsoptionalstring[]IsolatedSubnetIdsoptional*[]*string#
List of isolated subnet IDs.

Default: The VPC does not have any isolated subnets

Must be undefined or match the availability zones in length and order.

isolatedSubnetIpv4CidrBlocksoptionalstring[]isolated_subnet_ipv4_cidr_blocksoptionaltyping.List[str]isolatedSubnetIpv4CidrBlocksoptionalList<String>IsolatedSubnetIpv4CidrBlocksoptionalstring[]IsolatedSubnetIpv4CidrBlocksoptional*[]*string#
List of IPv4 CIDR blocks for the isolated subnets.

Default: Retrieving the IPv4 CIDR block of any isolated subnet will fail

Must be undefined or have an entry for every isolated subnet group.

isolatedSubnetNamesoptionalstring[]isolated_subnet_namesoptionaltyping.List[str]isolatedSubnetNamesoptionalList<String>IsolatedSubnetNamesoptionalstring[]IsolatedSubnetNamesoptional*[]*string#
List of names for the isolated subnets.

Default: All isolated subnets will have the name Isolated

Must be undefined or have a name for every isolated subnet group.

isolatedSubnetRouteTableIdsoptionalstring[]isolated_subnet_route_table_idsoptionaltyping.List[str]isolatedSubnetRouteTableIdsoptionalList<String>IsolatedSubnetRouteTableIdsoptionalstring[]IsolatedSubnetRouteTableIdsoptional*[]*string#
List of IDs of route tables for the isolated subnets.

Default: Retrieving the route table ID of any isolated subnet will fail

Must be undefined or have a name for every isolated subnet group.

privateSubnetIdsoptionalstring[]private_subnet_idsoptionaltyping.List[str]privateSubnetIdsoptionalList<String>PrivateSubnetIdsoptionalstring[]PrivateSubnetIdsoptional*[]*string#
List of private subnet IDs.

Default: The VPC does not have any private subnets

Must be undefined or match the availability zones in length and order.

privateSubnetIpv4CidrBlocksoptionalstring[]private_subnet_ipv4_cidr_blocksoptionaltyping.List[str]privateSubnetIpv4CidrBlocksoptionalList<String>PrivateSubnetIpv4CidrBlocksoptionalstring[]PrivateSubnetIpv4CidrBlocksoptional*[]*string#
List of IPv4 CIDR blocks for the private subnets.

Default: Retrieving the IPv4 CIDR block of any private subnet will fail

Must be undefined or have an entry for every private subnet group.

privateSubnetNamesoptionalstring[]private_subnet_namesoptionaltyping.List[str]privateSubnetNamesoptionalList<String>PrivateSubnetNamesoptionalstring[]PrivateSubnetNamesoptional*[]*string#
List of names for the private subnets.

Default: All private subnets will have the name Private

Must be undefined or have a name for every private subnet group.

privateSubnetRouteTableIdsoptionalstring[]private_subnet_route_table_idsoptionaltyping.List[str]privateSubnetRouteTableIdsoptionalList<String>PrivateSubnetRouteTableIdsoptionalstring[]PrivateSubnetRouteTableIdsoptional*[]*string#
List of IDs of route tables for the private subnets.

Default: Retrieving the route table ID of any private subnet will fail

Must be undefined or have a name for every private subnet group.

publicSubnetIdsoptionalstring[]public_subnet_idsoptionaltyping.List[str]publicSubnetIdsoptionalList<String>PublicSubnetIdsoptionalstring[]PublicSubnetIdsoptional*[]*string#
List of public subnet IDs.

Default: The VPC does not have any public subnets

Must be undefined or match the availability zones in length and order.

publicSubnetIpv4CidrBlocksoptionalstring[]public_subnet_ipv4_cidr_blocksoptionaltyping.List[str]publicSubnetIpv4CidrBlocksoptionalList<String>PublicSubnetIpv4CidrBlocksoptionalstring[]PublicSubnetIpv4CidrBlocksoptional*[]*string#
List of IPv4 CIDR blocks for the public subnets.

Default: Retrieving the IPv4 CIDR block of any public subnet will fail

Must be undefined or have an entry for every public subnet group.

publicSubnetNamesoptionalstring[]public_subnet_namesoptionaltyping.List[str]publicSubnetNamesoptionalList<String>PublicSubnetNamesoptionalstring[]PublicSubnetNamesoptional*[]*string#
List of names for the public subnets.

Default: All public subnets will have the name Public

Must be undefined or have a name for every public subnet group.

publicSubnetRouteTableIdsoptionalstring[]public_subnet_route_table_idsoptionaltyping.List[str]publicSubnetRouteTableIdsoptionalList<String>PublicSubnetRouteTableIdsoptionalstring[]PublicSubnetRouteTableIdsoptional*[]*string#
List of IDs of route tables for the public subnets.

Default: Retrieving the route table ID of any public subnet will fail

Must be undefined or have a name for every public subnet group.

regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
The region the VPC is in.

Default: The region of the stack where the VPC belongs to

vpcCidrBlockoptionalstringvpc_cidr_blockoptionalstrvpcCidrBlockoptionalStringVpcCidrBlockoptionalstringVpcCidrBlockoptional*string#
VPC's CIDR range.

Default: Retrieving the CIDR from the VPC will fail

vpcIdstringvpc_idstrvpcIdStringVpcIdstringVpcId*stringrequired#
VPC's identifier.
vpnGatewayIdoptionalstringvpn_gateway_idoptionalstrvpnGatewayIdoptionalStringVpnGatewayIdoptionalstringVpnGatewayIdoptional*string#
VPN gateway's identifier.