Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnVPNConnectionPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnVPNConnectionPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVPNConnectionPropsMixin>

Enclosing class:

CfnVPNConnectionPropsMixin

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

A fluent builder for CfnVPNConnectionPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnVPNConnectionPropsMixin	build()
static CfnVPNConnectionPropsMixin.Builder	create()
static CfnVPNConnectionPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnVPNConnectionPropsMixin.Builder	customerGatewayId(String customerGatewayId)	The ID of the customer gateway at your end of the VPN connection.
CfnVPNConnectionPropsMixin.Builder	customerGatewayId(ICustomerGatewayRef customerGatewayId)	The ID of the customer gateway at your end of the VPN connection.
CfnVPNConnectionPropsMixin.Builder	enableAcceleration(Boolean enableAcceleration)	Indicate whether to enable acceleration for the VPN connection.
CfnVPNConnectionPropsMixin.Builder	enableAcceleration(IResolvable enableAcceleration)	Indicate whether to enable acceleration for the VPN connection.
CfnVPNConnectionPropsMixin.Builder	localIpv4NetworkCidr(String localIpv4NetworkCidr)	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
CfnVPNConnectionPropsMixin.Builder	localIpv6NetworkCidr(String localIpv6NetworkCidr)	The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
CfnVPNConnectionPropsMixin.Builder	outsideIpAddressType(String outsideIpAddressType)	The type of IP address assigned to the outside interface of the customer gateway device.
CfnVPNConnectionPropsMixin.Builder	preSharedKeyStorage(String preSharedKeyStorage)	Describes the storage location for an instance store-backed AMI.
CfnVPNConnectionPropsMixin.Builder	remoteIpv4NetworkCidr(String remoteIpv4NetworkCidr)	The IPv4 CIDR on the AWS side of the VPN connection.
CfnVPNConnectionPropsMixin.Builder	remoteIpv6NetworkCidr(String remoteIpv6NetworkCidr)	The IPv6 CIDR on the AWS side of the VPN connection.
CfnVPNConnectionPropsMixin.Builder	staticRoutesOnly(Boolean staticRoutesOnly)	Indicates whether the VPN connection uses static routes only.
CfnVPNConnectionPropsMixin.Builder	staticRoutesOnly(IResolvable staticRoutesOnly)	Indicates whether the VPN connection uses static routes only.
CfnVPNConnectionPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Any tags assigned to the VPN connection.
CfnVPNConnectionPropsMixin.Builder	transitGatewayId(String transitGatewayId)	The ID of the transit gateway associated with the VPN connection.
CfnVPNConnectionPropsMixin.Builder	transitGatewayId(ITransitGatewayRef transitGatewayId)	The ID of the transit gateway associated with the VPN connection.
CfnVPNConnectionPropsMixin.Builder	transportTransitGatewayAttachmentId(String transportTransitGatewayAttachmentId)	The transit gateway attachment ID to use for the VPN tunnel.
CfnVPNConnectionPropsMixin.Builder	tunnelBandwidth(String tunnelBandwidth)	The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity.
CfnVPNConnectionPropsMixin.Builder	tunnelInsideIpVersion(String tunnelInsideIpVersion)	Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
CfnVPNConnectionPropsMixin.Builder	type(String type)	The type of VPN connection.
CfnVPNConnectionPropsMixin.Builder	vpnConcentratorId(String vpnConcentratorId)	The ID of the VPN concentrator to associate with the VPN connection.
CfnVPNConnectionPropsMixin.Builder	vpnGatewayId(String vpnGatewayId)	The ID of the virtual private gateway at the AWS side of the VPN connection.
CfnVPNConnectionPropsMixin.Builder	vpnGatewayId(IVPNGatewayRef vpnGatewayId)	The ID of the virtual private gateway at the AWS side of the VPN connection.
CfnVPNConnectionPropsMixin.Builder	vpnTunnelOptionsSpecifications(List<? extends Object> vpnTunnelOptionsSpecifications)	The tunnel options for the VPN connection.
CfnVPNConnectionPropsMixin.Builder	vpnTunnelOptionsSpecifications(IResolvable vpnTunnelOptionsSpecifications)	The tunnel options for the VPN connection.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnVPNConnectionPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnVPNConnectionPropsMixin.Builder.

create

@Stability(Stable)
public static CfnVPNConnectionPropsMixin.Builder create()

Returns:

a new instance of CfnVPNConnectionPropsMixin.Builder.

customerGatewayId

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder customerGatewayId(String customerGatewayId)

The ID of the customer gateway at your end of the VPN connection.

Parameters:

customerGatewayId - The ID of the customer gateway at your end of the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-customergatewayid

customerGatewayId

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder customerGatewayId(ICustomerGatewayRef customerGatewayId)

The ID of the customer gateway at your end of the VPN connection.

Parameters:

customerGatewayId - The ID of the customer gateway at your end of the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-customergatewayid

enableAcceleration

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder enableAcceleration(Boolean enableAcceleration)

Indicate whether to enable acceleration for the VPN connection.

Default: false

Parameters:

enableAcceleration - Indicate whether to enable acceleration for the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-enableacceleration

enableAcceleration

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder enableAcceleration(IResolvable enableAcceleration)

Indicate whether to enable acceleration for the VPN connection.

Default: false

Parameters:

enableAcceleration - Indicate whether to enable acceleration for the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-enableacceleration

localIpv4NetworkCidr

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder localIpv4NetworkCidr(String localIpv4NetworkCidr)

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: 0.0.0.0/0

Parameters:

localIpv4NetworkCidr - The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-localipv4networkcidr

localIpv6NetworkCidr

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder localIpv6NetworkCidr(String localIpv6NetworkCidr)

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: ::/0

Parameters:

localIpv6NetworkCidr - The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-localipv6networkcidr

outsideIpAddressType

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder outsideIpAddressType(String outsideIpAddressType)

The type of IP address assigned to the outside interface of the customer gateway device.

Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

Default: PublicIpv4

Parameters:

outsideIpAddressType - The type of IP address assigned to the outside interface of the customer gateway device. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-outsideipaddresstype

preSharedKeyStorage

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder preSharedKeyStorage(String preSharedKeyStorage)

Describes the storage location for an instance store-backed AMI.

Parameters:

preSharedKeyStorage - Describes the storage location for an instance store-backed AMI. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-presharedkeystorage

remoteIpv4NetworkCidr

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder remoteIpv4NetworkCidr(String remoteIpv4NetworkCidr)

The IPv4 CIDR on the AWS side of the VPN connection.

Default: 0.0.0.0/0

Parameters:

remoteIpv4NetworkCidr - The IPv4 CIDR on the AWS side of the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-remoteipv4networkcidr

remoteIpv6NetworkCidr

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder remoteIpv6NetworkCidr(String remoteIpv6NetworkCidr)

The IPv6 CIDR on the AWS side of the VPN connection.

Default: ::/0

Parameters:

remoteIpv6NetworkCidr - The IPv6 CIDR on the AWS side of the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-remoteipv6networkcidr

staticRoutesOnly

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder staticRoutesOnly(Boolean staticRoutesOnly)

Indicates whether the VPN connection uses static routes only.

Static routes must be used for devices that don't support BGP.

If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify true .

Parameters:

staticRoutesOnly - Indicates whether the VPN connection uses static routes only. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-staticroutesonly

staticRoutesOnly

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder staticRoutesOnly(IResolvable staticRoutesOnly)

Indicates whether the VPN connection uses static routes only.

Static routes must be used for devices that don't support BGP.

If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify true .

Parameters:

staticRoutesOnly - Indicates whether the VPN connection uses static routes only. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-staticroutesonly

tags

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder tags(List<? extends CfnTag> tags)

Any tags assigned to the VPN connection.

Parameters:

tags - Any tags assigned to the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tags

transitGatewayId

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder transitGatewayId(String transitGatewayId)

The ID of the transit gateway associated with the VPN connection.

You must specify either TransitGatewayId or VpnGatewayId , but not both.

Parameters:

transitGatewayId - The ID of the transit gateway associated with the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transitgatewayid

transitGatewayId

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder transitGatewayId(ITransitGatewayRef transitGatewayId)

The ID of the transit gateway associated with the VPN connection.

You must specify either TransitGatewayId or VpnGatewayId , but not both.

Parameters:

transitGatewayId - The ID of the transit gateway associated with the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transitgatewayid

transportTransitGatewayAttachmentId

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder transportTransitGatewayAttachmentId(String transportTransitGatewayAttachmentId)

The transit gateway attachment ID to use for the VPN tunnel.

Required if OutsideIpAddressType is set to PrivateIpv4 .

Parameters:

transportTransitGatewayAttachmentId - The transit gateway attachment ID to use for the VPN tunnel. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-transporttransitgatewayattachmentid

tunnelBandwidth

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder tunnelBandwidth(String tunnelBandwidth)

The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity.

standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. The default value is standard . Existing VPN connections without a bandwidth setting will automatically default to standard .

Default: - "standard"

Parameters:

tunnelBandwidth - The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tunnelbandwidth

tunnelInsideIpVersion

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder tunnelInsideIpVersion(String tunnelInsideIpVersion)

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Default: ipv4

Parameters:

tunnelInsideIpVersion - Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-tunnelinsideipversion

type

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder type(String type)

The type of VPN connection.

Parameters:

type - The type of VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-type

vpnConcentratorId

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder vpnConcentratorId(String vpnConcentratorId)

The ID of the VPN concentrator to associate with the VPN connection.

Parameters:

vpnConcentratorId - The ID of the VPN concentrator to associate with the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpnconcentratorid

vpnGatewayId

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder vpnGatewayId(String vpnGatewayId)

The ID of the virtual private gateway at the AWS side of the VPN connection.

You must specify either TransitGatewayId or VpnGatewayId , but not both.

Parameters:

vpnGatewayId - The ID of the virtual private gateway at the AWS side of the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpngatewayid

vpnGatewayId

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder vpnGatewayId(IVPNGatewayRef vpnGatewayId)

The ID of the virtual private gateway at the AWS side of the VPN connection.

You must specify either TransitGatewayId or VpnGatewayId , but not both.

Parameters:

vpnGatewayId - The ID of the virtual private gateway at the AWS side of the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpngatewayid

vpnTunnelOptionsSpecifications

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder vpnTunnelOptionsSpecifications(IResolvable vpnTunnelOptionsSpecifications)

The tunnel options for the VPN connection.

Parameters:

vpnTunnelOptionsSpecifications - The tunnel options for the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications

vpnTunnelOptionsSpecifications

@Stability(Stable)
public CfnVPNConnectionPropsMixin.Builder vpnTunnelOptionsSpecifications(List<? extends Object> vpnTunnelOptionsSpecifications)

The tunnel options for the VPN connection.

Parameters:

vpnTunnelOptionsSpecifications - The tunnel options for the VPN connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications

build

@Stability(Stable)
public CfnVPNConnectionPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnVPNConnectionPropsMixin.