Package software.amazon.awscdk.services.ec2

Class CfnVPNConnection.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnVPNConnection.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVPNConnection>

Enclosing class:

CfnVPNConnection

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

A fluent builder for CfnVPNConnection.

Method Summary

Modifier and Type	Method	Description
CfnVPNConnection	build()
static CfnVPNConnection.Builder	create(software.constructs.Construct scope, String id)
CfnVPNConnection.Builder	customerGatewayId(String customerGatewayId)	The ID of the customer gateway at your end of the VPN connection.
CfnVPNConnection.Builder	enableAcceleration(Boolean enableAcceleration)	Indicate whether to enable acceleration for the VPN connection.
CfnVPNConnection.Builder	enableAcceleration(IResolvable enableAcceleration)	Indicate whether to enable acceleration for the VPN connection.
CfnVPNConnection.Builder	localIpv4NetworkCidr(String localIpv4NetworkCidr)	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
CfnVPNConnection.Builder	localIpv6NetworkCidr(String localIpv6NetworkCidr)	The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
CfnVPNConnection.Builder	outsideIpAddressType(String outsideIpAddressType)	The type of IPv4 address assigned to the outside interface of the customer gateway device.
CfnVPNConnection.Builder	remoteIpv4NetworkCidr(String remoteIpv4NetworkCidr)	The IPv4 CIDR on the AWS side of the VPN connection.
CfnVPNConnection.Builder	remoteIpv6NetworkCidr(String remoteIpv6NetworkCidr)	The IPv6 CIDR on the AWS side of the VPN connection.
CfnVPNConnection.Builder	staticRoutesOnly(Boolean staticRoutesOnly)	Indicates whether the VPN connection uses static routes only.
CfnVPNConnection.Builder	staticRoutesOnly(IResolvable staticRoutesOnly)	Indicates whether the VPN connection uses static routes only.
CfnVPNConnection.Builder	tags(List<? extends CfnTag> tags)	Any tags assigned to the VPN connection.
CfnVPNConnection.Builder	transitGatewayId(String transitGatewayId)	The ID of the transit gateway associated with the VPN connection.
CfnVPNConnection.Builder	transportTransitGatewayAttachmentId(String transportTransitGatewayAttachmentId)	The transit gateway attachment ID to use for the VPN tunnel.
CfnVPNConnection.Builder	tunnelInsideIpVersion(String tunnelInsideIpVersion)	Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
CfnVPNConnection.Builder	type(String type)	The type of VPN connection.
CfnVPNConnection.Builder	vpnGatewayId(String vpnGatewayId)	The ID of the virtual private gateway at the AWS side of the VPN connection.
CfnVPNConnection.Builder	vpnTunnelOptionsSpecifications(List<? extends Object> vpnTunnelOptionsSpecifications)	The tunnel options for the VPN connection.
CfnVPNConnection.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 CfnVPNConnection.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnVPNConnection.Builder.

customerGatewayId

@Stability(Stable)
public CfnVPNConnection.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

type

@Stability(Stable)
public CfnVPNConnection.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

enableAcceleration

@Stability(Stable)
public CfnVPNConnection.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 CfnVPNConnection.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 CfnVPNConnection.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 CfnVPNConnection.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 CfnVPNConnection.Builder outsideIpAddressType(String outsideIpAddressType)

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

Valid values: PrivateIpv4 | PublicIpv4

Default: PublicIpv4

Parameters:

outsideIpAddressType - The type of IPv4 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

remoteIpv4NetworkCidr

@Stability(Stable)
public CfnVPNConnection.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 CfnVPNConnection.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 CfnVPNConnection.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 CfnVPNConnection.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 CfnVPNConnection.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 CfnVPNConnection.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

transportTransitGatewayAttachmentId

@Stability(Stable)
public CfnVPNConnection.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

tunnelInsideIpVersion

@Stability(Stable)
public CfnVPNConnection.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

vpnGatewayId

@Stability(Stable)
public CfnVPNConnection.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

vpnTunnelOptionsSpecifications

@Stability(Stable)
public CfnVPNConnection.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 CfnVPNConnection.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 CfnVPNConnection build()

Specified by:

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

Returns:

a newly built instance of CfnVPNConnection.