@aws-cdk_cloud-assembly-schema.VpcContextQuery

interface VpcContextQuery

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.VpcContextQuery
Javasoftware.amazon.awscdk.cloudassembly.schema.VpcContextQuery
Pythonaws_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,
  returnVpnGateways: false,
  subnetGroupNameTag: 'subnetGroupNameTag',
};

Properties

NameTypeDescription
accountstringQuery account.
filter{ [string]: string }Filters to apply to the VPC.
regionstringQuery region.
lookupRoleArn?stringThe ARN of the role that should be used to look up the missing values.
returnAsymmetricSubnets?booleanWhether to populate the subnetGroups field of the VpcContextResponse, which contains potentially asymmetric subnet groups.
returnVpnGateways?booleanWhether to populate the vpnGatewayId field of the VpcContextResponse, which contains the VPN Gateway ID, if one exists.
subnetGroupNameTag?stringOptional 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.

See also: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html


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 VpcContextResponse, which contains potentially asymmetric subnet groups.


returnVpnGateways?

Type: boolean (optional, default: true)

Whether to populate the vpnGatewayId field of the VpcContextResponse, which contains the VPN Gateway ID, if one exists.

You can explicitly disable this in order to avoid the lookup if you know the VPC does not have a VPN Gatway attached.


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.