Package software.amazon.awscdk.cloud_assembly_schema

Class VpcContextQuery.Builder

java.lang.Object

software.amazon.awscdk.cloud_assembly_schema.VpcContextQuery.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<VpcContextQuery>

Enclosing interface:

VpcContextQuery

@Stability(Stable)
public static final class VpcContextQuery.Builder
extends Object
implements software.amazon.jsii.Builder<VpcContextQuery>

A builder for VpcContextQuery

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VpcContextQuery.Builder	account(String account)	Sets the value of ContextLookupRoleOptions.getAccount()
VpcContextQuery.Builder	assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)	Sets the value of ContextLookupRoleOptions.getAssumeRoleAdditionalOptions()
VpcContextQuery	build()	Builds the configured instance.
VpcContextQuery.Builder	filter(Map<String,String> filter)	Sets the value of VpcContextQuery.getFilter()
VpcContextQuery.Builder	lookupRoleArn(String lookupRoleArn)	Sets the value of ContextLookupRoleOptions.getLookupRoleArn()
VpcContextQuery.Builder	lookupRoleExternalId(String lookupRoleExternalId)	Sets the value of ContextLookupRoleOptions.getLookupRoleExternalId()
VpcContextQuery.Builder	region(String region)	Sets the value of ContextLookupRoleOptions.getRegion()
VpcContextQuery.Builder	returnAsymmetricSubnets(Boolean returnAsymmetricSubnets)	Sets the value of VpcContextQuery.getReturnAsymmetricSubnets()
VpcContextQuery.Builder	returnVpnGateways(Boolean returnVpnGateways)	Sets the value of VpcContextQuery.getReturnVpnGateways()
VpcContextQuery.Builder	subnetGroupNameTag(String subnetGroupNameTag)	Sets the value of VpcContextQuery.getSubnetGroupNameTag()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

filter

@Stability(Stable)
public VpcContextQuery.Builder filter(Map<String,String> filter)

Sets the value of VpcContextQuery.getFilter()

Parameters:

filter - Filters to apply to the VPC. This parameter is required. Filter parameters are the same as passed to DescribeVpcs.

Returns:

this

returnAsymmetricSubnets

@Stability(Stable)
public VpcContextQuery.Builder returnAsymmetricSubnets(Boolean returnAsymmetricSubnets)

Sets the value of VpcContextQuery.getReturnAsymmetricSubnets()

Parameters:

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

Returns:

this

returnVpnGateways

@Stability(Stable)
public VpcContextQuery.Builder returnVpnGateways(Boolean returnVpnGateways)

Sets the value of VpcContextQuery.getReturnVpnGateways()

Parameters:

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

Returns:

this

subnetGroupNameTag

@Stability(Stable)
public VpcContextQuery.Builder subnetGroupNameTag(String subnetGroupNameTag)

Sets the value of VpcContextQuery.getSubnetGroupNameTag()

Parameters:

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

Returns:

this

account

@Stability(Stable)
public VpcContextQuery.Builder account(String account)

Sets the value of ContextLookupRoleOptions.getAccount()

Parameters:

account - Query account. This parameter is required.

Returns:

this

region

@Stability(Stable)
public VpcContextQuery.Builder region(String region)

Sets the value of ContextLookupRoleOptions.getRegion()

Parameters:

region - Query region. This parameter is required.

Returns:

this

assumeRoleAdditionalOptions

@Stability(Stable)
public VpcContextQuery.Builder assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)

Sets the value of ContextLookupRoleOptions.getAssumeRoleAdditionalOptions()

Parameters:

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

Returns:

this

lookupRoleArn

@Stability(Stable)
public VpcContextQuery.Builder lookupRoleArn(String lookupRoleArn)

Sets the value of ContextLookupRoleOptions.getLookupRoleArn()

Parameters:

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

Returns:

this

lookupRoleExternalId

@Stability(Stable)
public VpcContextQuery.Builder lookupRoleExternalId(String lookupRoleExternalId)

Sets the value of ContextLookupRoleOptions.getLookupRoleExternalId()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public VpcContextQuery build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<VpcContextQuery>

Returns:

a new instance of VpcContextQuery

Throws:

NullPointerException - if any required attribute was not provided