Skip to content

VpcContextQuery

Query input for looking up a VPC.

Initializer

import ros_cdk_assembly_schema
ros_cdk_assembly_schema.VpcContextQuery(
  account: str,
  filter: typing.Mapping[str],
  region: str,
  return_asymmetric_subnets: bool = None,
  subnet_group_name_tag: str = None
)

Properties

Name Type Description
account str Query account.
filter typing.Mapping[str] Filters to apply to the VPC.
region str Query region.
return_asymmetric_subnets bool Whether to populate the subnetGroups field of the {@link VpcContextResponse}, which contains potentially asymmetric subnet groups.
subnet_group_name_tag str Optional tag for subnet group name.

accountRequired

account: str
  • Type: str

Query account.


filterRequired

filter: typing.Mapping[str]
  • Type: typing.Mapping[str]

Filters to apply to the VPC.

Filter parameters are the same as passed to DescribeVpcs.


regionRequired

region: str
  • Type: str

Query region.


return_asymmetric_subnetsOptional

return_asymmetric_subnets: bool
  • Type: bool
  • Default: false

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


subnet_group_name_tagOptional

subnet_group_name_tag: str
  • Type: str
  • 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