AWS CDK Reference

Appearance

v2.273.0

VpcLookupOptions Struct ​

Properties for looking up an existing VPC.

The combination of properties must specify filter down to exactly one non-default VPC, otherwise an error is raised.

Source
aws-ec2/lib/vpc-lookup.ts
Type last changed
v2.73.0 · 6 Apr 2023

Example ​

ts
const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {
  isDefault: true,
});
const cluster = new ecs.Cluster(this, 'ECSCluster', { vpc });

const taskDefinition = new ecs.TaskDefinition(this, 'TD', {
  compatibility: ecs.Compatibility.EC2,
});

taskDefinition.addContainer('TheContainer', {
  image: ecs.ContainerImage.fromRegistry('foo/bar'),
  memoryLimitMiB: 256,
});

const runTask = new tasks.EcsRunTask(this, 'Run', {
  integrationPattern: sfn.IntegrationPattern.RUN_JOB,
  cluster,
  taskDefinition,
  launchTarget: new tasks.EcsEc2LaunchTarget(),
  enableExecuteCommand: true,
});

Properties ​

isDefaultbooleanis_defaultboolisDefaultBooleanIsDefaultboolIsDefault*bool= Don't care whether we return the…#
Whether to match the default VPC.
default

Default: Don't care whether we return the default VPC

ownerAccountIdstringowner_account_idstrownerAccountIdStringOwnerAccountIdstringOwnerAccountId*string= the account id of the parent sta…#
The ID of the AWS account that owns the VPC.
default

Default: the account id of the parent stack

regionstringregionstrregionStringRegionstringRegion*string= Current stack's environment regi…#
Optional to override inferred region.
default

Default: Current stack's environment region

returnVpnGatewaysbooleanreturn_vpn_gatewaysboolreturnVpnGatewaysBooleanReturnVpnGatewaysboolReturnVpnGateways*bool= true#
Whether to look up whether a VPN Gateway is attached to the looked up VPC.
notes

You can set this to false if you know the VPC does not have a VPN Gateway attached, in order to avoid an API call.

If you change this property from false to true or undefined, you may need to clear the corresponding context entry in cdk.context.json in order to trigger a new lookup.

subnetGroupNameTagstringsubnet_group_name_tagstrsubnetGroupNameTagStringSubnetGroupNameTagstringSubnetGroupNameTag*string= aws-cdk:subnet-name#
Optional tag for subnet group name.

If not provided, we'll look at the aws-cdk:subnet-name tag. If the subnet does not have the specified tag, we'll use its type as the name.

tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= Don't filter on tags#
Tags on the VPC.

The VPC must have all of these tags

vpcIdstringvpc_idstrvpcIdStringVpcIdstringVpcId*string= Don't filter on vpcId#
The ID of the VPC.

If given, will import exactly this VPC.

vpcNamestringvpc_namestrvpcNameStringVpcNamestringVpcName*string= Don't filter on vpcName#
The name of the VPC.

If given, will import the VPC with this name.