Package software.amazon.awscdk.cloudassembly.schema

Interface VpcContextQuery

All Superinterfaces:

ContextLookupRoleOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VpcContextQuery.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-07-30T08:06:26.727Z")
@Stability(Stable)
public interface VpcContextQuery
extends software.amazon.jsii.JsiiSerializable, ContextLookupRoleOptions

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 software.amazon.awscdk.cloudassembly.schema.*;
 Object assumeRoleAdditionalOptions;
 VpcContextQuery vpcContextQuery = VpcContextQuery.builder()
         .account("account")
         .filter(Map.of(
                 "filterKey", "filter"))
         .region("region")
         // the properties below are optional
         .assumeRoleAdditionalOptions(Map.of(
                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
         .lookupRoleArn("lookupRoleArn")
         .lookupRoleExternalId("lookupRoleExternalId")
         .returnAsymmetricSubnets(false)
         .returnVpnGateways(false)
         .subnetGroupNameTag("subnetGroupNameTag")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	VpcContextQuery.Builder	A builder for VpcContextQuery
static class	VpcContextQuery.Jsii$Proxy	An implementation for VpcContextQuery

Method Summary

Modifier and Type	Method	Description
static VpcContextQuery.Builder	builder()
Map<String,String>	getFilter()	Filters to apply to the VPC.
default Boolean	getReturnAsymmetricSubnets()	Whether to populate the subnetGroups field of the VpcContextResponse, which contains potentially asymmetric subnet groups.
default Boolean	getReturnVpnGateways()	Whether to populate the vpnGatewayId field of the VpcContextResponse, which contains the VPN Gateway ID, if one exists.
default String	getSubnetGroupNameTag()	Optional tag for subnet group name.

Methods inherited from interface software.amazon.awscdk.cloudassembly.schema.ContextLookupRoleOptions

getAccount, getAssumeRoleAdditionalOptions, getLookupRoleArn, getLookupRoleExternalId, getRegion

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFilter

@Stability(Stable)
@NotNull
Map<String,String> getFilter()

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

getReturnAsymmetricSubnets

@Stability(Stable)
@Nullable
default Boolean getReturnAsymmetricSubnets()

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

Default: false

getReturnVpnGateways

@Stability(Stable)
@Nullable
default Boolean getReturnVpnGateways()

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

getSubnetGroupNameTag

@Stability(Stable)
@Nullable
default String getSubnetGroupNameTag()

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'

builder

@Stability(Stable)
static VpcContextQuery.Builder builder()

Returns:

a VpcContextQuery.Builder of VpcContextQuery