VpcContextQuery

class aws_cdk.cloud_assembly_schema.VpcContextQuery(*, account, filter, region, lookup_role_arn=None, return_asymmetric_subnets=None, subnet_group_name_tag=None)

Bases: object

Query input for looking up a VPC.

Parameters:

  • account (str) – Query account.

  • filter (Mapping[str, str]) – Filters to apply to the VPC. Filter parameters are the same as passed to DescribeVpcs.

  • region (str) – Query region.

  • lookup_role_arn (Optional[str]) – The ARN of the role that should be used to look up the missing values. Default: - None

  • return_asymmetric_subnets (Optional[bool]) – Whether to populate the subnetGroups field of the {@link VpcContextResponse}, which contains potentially asymmetric subnet groups. Default: false

  • subnet_group_name_tag (Optional[str]) – 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. Default: ‘aws-cdk:subnet-name’

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.cloud_assembly_schema as cloud_assembly_schema

vpc_context_query = cloud_assembly_schema.VpcContextQuery(
    account="account",
    filter={
        "filter_key": "filter"
    },
    region="region",

    # the properties below are optional
    lookup_role_arn="lookupRoleArn",
    return_asymmetric_subnets=False,
    subnet_group_name_tag="subnetGroupNameTag"
)

Attributes

account

Query account.

filter

Filters to apply to the VPC.

Filter parameters are the same as passed to DescribeVpcs.

See:

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

lookup_role_arn

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

Default:

  • None

region

Query region.

return_asymmetric_subnets

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

Default:

false

subnet_group_name_tag

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.

Default:

‘aws-cdk:subnet-name’