VpcContextQuery

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

Bases: ContextLookupRoleOptions

Query input for looking up a VPC.

Parameters:

  • account (str) – Query account.

  • region (str) – Query region.

  • assume_role_additional_options (Optional[Mapping[str, Any]]) – 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. Default: - No additional options.

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

  • lookup_role_external_id (Optional[str]) – The ExternalId that needs to be supplied while assuming this role. Default: - No ExternalId will be supplied

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

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

  • return_vpn_gateways (Optional[bool]) – 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. Default: true

  • 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’

Attributes

account

Query account.

assume_role_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.

Default:

  • No additional options.

See:

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

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

lookup_role_external_id

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

Default:

  • No ExternalId will be supplied

region

Query region.

return_asymmetric_subnets

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

Default:

false

return_vpn_gateways

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.

Default:

true

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’