Package software.amazon.awscdk.services.ec2

Class VpcLookupOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.VpcLookupOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<VpcLookupOptions>

Enclosing interface:

VpcLookupOptions

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

A builder for VpcLookupOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VpcLookupOptions	build()	Builds the configured instance.
VpcLookupOptions.Builder	isDefault(Boolean isDefault)	Sets the value of VpcLookupOptions.getIsDefault()
VpcLookupOptions.Builder	ownerAccountId(String ownerAccountId)	Sets the value of VpcLookupOptions.getOwnerAccountId()
VpcLookupOptions.Builder	region(String region)	Sets the value of VpcLookupOptions.getRegion()
VpcLookupOptions.Builder	returnVpnGateways(Boolean returnVpnGateways)	Sets the value of VpcLookupOptions.getReturnVpnGateways()
VpcLookupOptions.Builder	subnetGroupNameTag(String subnetGroupNameTag)	Sets the value of VpcLookupOptions.getSubnetGroupNameTag()
VpcLookupOptions.Builder	tags(Map<String,String> tags)	Sets the value of VpcLookupOptions.getTags()
VpcLookupOptions.Builder	vpcId(String vpcId)	Sets the value of VpcLookupOptions.getVpcId()
VpcLookupOptions.Builder	vpcName(String vpcName)	Sets the value of VpcLookupOptions.getVpcName()

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

isDefault

@Stability(Stable)
public VpcLookupOptions.Builder isDefault(Boolean isDefault)

Sets the value of VpcLookupOptions.getIsDefault()

Parameters:

isDefault - Whether to match the default VPC.

Returns:

this

ownerAccountId

@Stability(Stable)
public VpcLookupOptions.Builder ownerAccountId(String ownerAccountId)

Sets the value of VpcLookupOptions.getOwnerAccountId()

Parameters:

ownerAccountId - The ID of the AWS account that owns the VPC.

Returns:

this

region

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

Sets the value of VpcLookupOptions.getRegion()

Parameters:

region - Optional to override inferred region.

Returns:

this

returnVpnGateways

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

Sets the value of VpcLookupOptions.getReturnVpnGateways()

Parameters:

returnVpnGateways - Whether to look up whether a VPN Gateway is attached to the looked up VPC. You can set this to false if you know the VPC does not have a VPN Gateway attached, in order to avoid an API call.

If you change this property from false to true or undefined, you may need to clear the corresponding context entry in cdk.context.json in order to trigger a new lookup.

Returns:

this

subnetGroupNameTag

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

Sets the value of VpcLookupOptions.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

tags

@Stability(Stable)
public VpcLookupOptions.Builder tags(Map<String,String> tags)

Sets the value of VpcLookupOptions.getTags()

Parameters:

tags - Tags on the VPC. The VPC must have all of these tags

Returns:

this

vpcId

@Stability(Stable)
public VpcLookupOptions.Builder vpcId(String vpcId)

Sets the value of VpcLookupOptions.getVpcId()

Parameters:

vpcId - The ID of the VPC. If given, will import exactly this VPC.

Returns:

this

vpcName

@Stability(Stable)
public VpcLookupOptions.Builder vpcName(String vpcName)

Sets the value of VpcLookupOptions.getVpcName()

Parameters:

vpcName - The name of the VPC. If given, will import the VPC with this name.

Returns:

this

build

@Stability(Stable)
public VpcLookupOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of VpcLookupOptions

Throws:

NullPointerException - if any required attribute was not provided