interface VpcContextQuery

Language	Type name
.NET	`Amazon.CDK.CloudAssembly.Schema.VpcContextQuery`
Java	`software.amazon.awscdk.cloudassembly.schema.VpcContextQuery`
Python	`aws_cdk.cloud_assembly_schema.VpcContextQuery`
TypeScript (source)	`@aws-cdk/cloud-assembly-schema` » `VpcContextQuery`

Query input for looking up a VPC.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';
const vpcContextQuery: cloud_assembly_schema.VpcContextQuery = {
  account: 'account',
  filter: {
    filterKey: 'filter',
  },
  region: 'region',

  // the properties below are optional
  lookupRoleArn: 'lookupRoleArn',
  returnAsymmetricSubnets: false,
  subnetGroupNameTag: 'subnetGroupNameTag',
};

Properties

Name	Type	Description
account	`string`	Query account.
filter	`{ [string]: string }`	Filters to apply to the VPC.
region	`string`	Query region.
lookupRoleArn?	`string`	The ARN of the role that should be used to look up the missing values.
returnAsymmetricSubnets?	`boolean`	Whether to populate the subnetGroups field of the {@link VpcContextResponse}, which contains potentially asymmetric subnet groups.
subnetGroupNameTag?	`string`	Optional tag for subnet group name.

account

Type: string

Query account.

filter

Type: { [string]: string }

Filters to apply to the VPC.

Filter parameters are the same as passed to DescribeVpcs.

region

Type: string

Query region.

lookupRoleArn?

Type: string (optional, default: None)

The ARN of the role that should be used to look up the missing values.

returnAsymmetricSubnets?

Type: boolean (optional, default: false)

Whether to populate the subnetGroups field of the {@link VpcContextResponse}, which contains potentially asymmetric subnet groups.

subnetGroupNameTag?

Type: string (optional, default: '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.