Skip to content

VpcContextQuery

Query input for looking up a VPC.

Initializer

import { VpcContextQuery } from '@alicloud/ros-cdk-assembly-schema'
const vpcContextQuery: VpcContextQuery = { ... }

Properties

Name Type Description
account string Query account.
filter {[ key: string ]: string} Filters to apply to the VPC.
region string Query region.
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.

accountRequired

public readonly account: string;
  • Type: string

Query account.


filterRequired

public readonly filter: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Filters to apply to the VPC.

Filter parameters are the same as passed to DescribeVpcs.


regionRequired

public readonly region: string;
  • Type: string

Query region.


returnAsymmetricSubnetsOptional

public readonly returnAsymmetricSubnets: boolean;
  • Type: boolean
  • Default: false

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


subnetGroupNameTagOptional

public readonly subnetGroupNameTag: string;
  • Type: string
  • Default: 'ros-cdk:subnet-name'

Optional tag for subnet group name.

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


Classes