interface VpcContextQuery

Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.VpcContextQuery
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#VpcContextQuery
Java	software.amazon.awscdk.cloud_assembly_schema.VpcContextQuery
Python	aws_cdk.cloud_assembly_schema.VpcContextQuery
TypeScript (source)	aws-cdk-lib » 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 { cloud_assembly_schema } from 'aws-cdk-lib';

declare const assumeRoleAdditionalOptions: any;
const vpcContextQuery: cloud_assembly_schema.VpcContextQuery = {
  account: 'account',
  filter: {
    filterKey: 'filter',
  },
  region: 'region',

  // the properties below are optional
  assumeRoleAdditionalOptions: {
    assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,
  },
  lookupRoleArn: 'lookupRoleArn',
  lookupRoleExternalId: 'lookupRoleExternalId',
  returnAsymmetricSubnets: false,
  returnVpnGateways: false,
  subnetGroupNameTag: 'subnetGroupNameTag',
};

Properties

Name	Type	Description
account	string	Query account.
filter	{ [string]: string }	Filters to apply to the VPC.
region	string	Query region.
assumeRoleAdditionalOptions?	{ [string]: any }	Additional options to pass to STS when assuming the lookup role.
lookupRoleArn?	string	The ARN of the role that should be used to look up the missing values.
lookupRoleExternalId?	string	The ExternalId that needs to be supplied while assuming this role.
returnAsymmetricSubnets?	boolean	Whether to populate the subnetGroups field of the VpcContextResponse, which contains potentially asymmetric subnet groups.
returnVpnGateways?	boolean	Whether to populate the vpnGatewayId field of the VpcContextResponse, which contains the VPN Gateway ID, if one exists.
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.

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

---

region

Type: string

Query region.

---

assumeRoleAdditionalOptions?

Type: { [string]: any } (optional, default: No additional options.)

Additional options to pass to STS when assuming the lookup role.

• RoleArn should not be used. Use the dedicated lookupRoleArn property instead.
• ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.

See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

---

lookupRoleArn?

Type: string (optional, default: None)

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

---

lookupRoleExternalId?

Type: string (optional, default: No ExternalId will be supplied)

The ExternalId that needs to be supplied while assuming this role.

---

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.