Package software.amazon.awscdk.services.ec2

Class CfnVPNConnection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnVPNConnection

All Implemented Interfaces:

IInspectable, IVPNConnectionRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:19.285Z")
@Stability(Stable)
public class CfnVPNConnection
extends CfnResource
implements IInspectable, IVPNConnectionRef, ITaggable

Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.

To specify a VPN connection between a transit gateway and customer gateway, use the TransitGatewayId and CustomerGatewayId properties.

To specify a VPN connection between a virtual private gateway and customer gateway, use the VpnGatewayId and CustomerGatewayId properties.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnVPNConnection cfnVPNConnection = CfnVPNConnection.Builder.create(this, "MyCfnVPNConnection")
         .customerGatewayId("customerGatewayId")
         .type("type")
         // the properties below are optional
         .enableAcceleration(false)
         .localIpv4NetworkCidr("localIpv4NetworkCidr")
         .localIpv6NetworkCidr("localIpv6NetworkCidr")
         .outsideIpAddressType("outsideIpAddressType")
         .preSharedKeyStorage("preSharedKeyStorage")
         .remoteIpv4NetworkCidr("remoteIpv4NetworkCidr")
         .remoteIpv6NetworkCidr("remoteIpv6NetworkCidr")
         .staticRoutesOnly(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transitGatewayId("transitGatewayId")
         .transportTransitGatewayAttachmentId("transportTransitGatewayAttachmentId")
         .tunnelBandwidth("tunnelBandwidth")
         .tunnelInsideIpVersion("tunnelInsideIpVersion")
         .vpnConcentratorId("vpnConcentratorId")
         .vpnGatewayId("vpnGatewayId")
         .vpnTunnelOptionsSpecifications(List.of(VpnTunnelOptionsSpecificationProperty.builder()
                 .dpdTimeoutAction("dpdTimeoutAction")
                 .dpdTimeoutSeconds(123)
                 .enableTunnelLifecycleControl(false)
                 .ikeVersions(List.of(Map.of(
                         "value", "value")))
                 .logOptions(VpnTunnelLogOptionsSpecificationProperty.builder()
                         .cloudwatchLogOptions(CloudwatchLogOptionsSpecificationProperty.builder()
                                 .bgpLogEnabled(false)
                                 .bgpLogGroupArn("bgpLogGroupArn")
                                 .bgpLogOutputFormat("bgpLogOutputFormat")
                                 .logEnabled(false)
                                 .logGroupArn("logGroupArn")
                                 .logOutputFormat("logOutputFormat")
                                 .build())
                         .build())
                 .phase1DhGroupNumbers(List.of(Phase1DHGroupNumbersRequestListValueProperty.builder()
                         .value(123)
                         .build()))
                 .phase1EncryptionAlgorithms(List.of(Phase1EncryptionAlgorithmsRequestListValueProperty.builder()
                         .value("value")
                         .build()))
                 .phase1IntegrityAlgorithms(List.of(Phase1IntegrityAlgorithmsRequestListValueProperty.builder()
                         .value("value")
                         .build()))
                 .phase1LifetimeSeconds(123)
                 .phase2DhGroupNumbers(List.of(Phase2DHGroupNumbersRequestListValueProperty.builder()
                         .value(123)
                         .build()))
                 .phase2EncryptionAlgorithms(List.of(Phase2EncryptionAlgorithmsRequestListValueProperty.builder()
                         .value("value")
                         .build()))
                 .phase2IntegrityAlgorithms(List.of(Phase2IntegrityAlgorithmsRequestListValueProperty.builder()
                         .value("value")
                         .build()))
                 .phase2LifetimeSeconds(123)
                 .preSharedKey("preSharedKey")
                 .rekeyFuzzPercentage(123)
                 .rekeyMarginTimeSeconds(123)
                 .replayWindowSize(123)
                 .startupAction("startupAction")
                 .tunnelInsideCidr("tunnelInsideCidr")
                 .tunnelInsideIpv6Cidr("tunnelInsideIpv6Cidr")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnVPNConnection.Builder	A fluent builder for CfnVPNConnection.
static interface	CfnVPNConnection.CloudwatchLogOptionsSpecificationProperty	Options for sending VPN tunnel logs to CloudWatch.
static interface	CfnVPNConnection.IKEVersionsRequestListValueProperty	The IKE version that is permitted for the VPN tunnel.
static interface	CfnVPNConnection.Phase1DHGroupNumbersRequestListValueProperty	Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.
static interface	CfnVPNConnection.Phase1EncryptionAlgorithmsRequestListValueProperty	Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.
static interface	CfnVPNConnection.Phase1IntegrityAlgorithmsRequestListValueProperty	Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.
static interface	CfnVPNConnection.Phase2DHGroupNumbersRequestListValueProperty	Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.
static interface	CfnVPNConnection.Phase2EncryptionAlgorithmsRequestListValueProperty	Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.
static interface	CfnVPNConnection.Phase2IntegrityAlgorithmsRequestListValueProperty	Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
static interface	CfnVPNConnection.VpnTunnelLogOptionsSpecificationProperty	Options for logging VPN tunnel activity.
static interface	CfnVPNConnection.VpnTunnelOptionsSpecificationProperty	The tunnel options for a single VPN tunnel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ec2.IVPNConnectionRef

IVPNConnectionRef.Jsii$Default, IVPNConnectionRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnVPNConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPNConnection(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVPNConnection(software.constructs.Construct scope, String id, CfnVPNConnectionProps props)	Create a new AWS::EC2::VPNConnection.

Method Summary

Modifier and Type	Method	Description
static String	arnForVPNConnection(IVPNConnectionRef resource)
static IVPNConnectionRef	fromVpnConnectionId(software.constructs.Construct scope, String id, String vpnConnectionId)	Creates a new IVPNConnectionRef from a vpnConnectionId.
String	getAttrVpnConnectionId()	The ID of the VPN connection.
protected Map<String,Object>	getCfnProperties()
String	getCustomerGatewayId()	The ID of the customer gateway at your end of the VPN connection.
Object	getEnableAcceleration()	Indicate whether to enable acceleration for the VPN connection.
String	getLocalIpv4NetworkCidr()	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
String	getLocalIpv6NetworkCidr()	The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
String	getOutsideIpAddressType()	The type of IP address assigned to the outside interface of the customer gateway device.
String	getPreSharedKeyStorage()	Describes the storage location for an instance store-backed AMI.
String	getRemoteIpv4NetworkCidr()	The IPv4 CIDR on the AWS side of the VPN connection.
String	getRemoteIpv6NetworkCidr()	The IPv6 CIDR on the AWS side of the VPN connection.
Object	getStaticRoutesOnly()	Indicates whether the VPN connection uses static routes only.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Any tags assigned to the VPN connection.
String	getTransitGatewayId()	The ID of the transit gateway associated with the VPN connection.
String	getTransportTransitGatewayAttachmentId()	The transit gateway attachment ID to use for the VPN tunnel.
String	getTunnelBandwidth()
String	getTunnelInsideIpVersion()	Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
String	getType()	The type of VPN connection.
String	getVpnConcentratorId()
VPNConnectionReference	getVpnConnectionRef()	A reference to a VPNConnection resource.
String	getVpnGatewayId()	The ID of the virtual private gateway at the AWS side of the VPN connection.
Object	getVpnTunnelOptionsSpecifications()	The tunnel options for the VPN connection.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnVPNConnection(Object x)	Checks whether the given object is a CfnVPNConnection.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomerGatewayId(String value)	The ID of the customer gateway at your end of the VPN connection.
void	setEnableAcceleration(Boolean value)	Indicate whether to enable acceleration for the VPN connection.
void	setEnableAcceleration(IResolvable value)	Indicate whether to enable acceleration for the VPN connection.
void	setLocalIpv4NetworkCidr(String value)	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
void	setLocalIpv6NetworkCidr(String value)	The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
void	setOutsideIpAddressType(String value)	The type of IP address assigned to the outside interface of the customer gateway device.
void	setPreSharedKeyStorage(String value)	Describes the storage location for an instance store-backed AMI.
void	setRemoteIpv4NetworkCidr(String value)	The IPv4 CIDR on the AWS side of the VPN connection.
void	setRemoteIpv6NetworkCidr(String value)	The IPv6 CIDR on the AWS side of the VPN connection.
void	setStaticRoutesOnly(Boolean value)	Indicates whether the VPN connection uses static routes only.
void	setStaticRoutesOnly(IResolvable value)	Indicates whether the VPN connection uses static routes only.
void	setTagsRaw(List<CfnTag> value)	Any tags assigned to the VPN connection.
void	setTransitGatewayId(String value)	The ID of the transit gateway associated with the VPN connection.
void	setTransportTransitGatewayAttachmentId(String value)	The transit gateway attachment ID to use for the VPN tunnel.
void	setTunnelBandwidth(String value)
void	setTunnelInsideIpVersion(String value)	Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
void	setType(String value)	The type of VPN connection.
void	setVpnConcentratorId(String value)
void	setVpnGatewayId(String value)	The ID of the virtual private gateway at the AWS side of the VPN connection.
void	setVpnTunnelOptionsSpecifications(List<Object> value)	The tunnel options for the VPN connection.
void	setVpnTunnelOptionsSpecifications(IResolvable value)	The tunnel options for the VPN connection.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnVPNConnection

protected CfnVPNConnection(software.amazon.jsii.JsiiObjectRef objRef)

CfnVPNConnection

protected CfnVPNConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVPNConnection

@Stability(Stable)
public CfnVPNConnection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnVPNConnectionProps props)

Create a new AWS::EC2::VPNConnection.

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.

props - Resource properties. This parameter is required.

Method Details

arnForVPNConnection

@Stability(Stable)
@NotNull
public static String arnForVPNConnection(@NotNull
 IVPNConnectionRef resource)

Parameters:

resource - This parameter is required.

fromVpnConnectionId

@Stability(Stable)
@NotNull
public static IVPNConnectionRef fromVpnConnectionId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String vpnConnectionId)

Creates a new IVPNConnectionRef from a vpnConnectionId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

vpnConnectionId - This parameter is required.

isCfnVPNConnection

@Stability(Stable)
@NotNull
public static Boolean isCfnVPNConnection(@NotNull
 Object x)

Checks whether the given object is a CfnVPNConnection.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrVpnConnectionId

@Stability(Stable)
@NotNull
public String getAttrVpnConnectionId()

The ID of the VPN connection.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getVpnConnectionRef

@Stability(Stable)
@NotNull
public VPNConnectionReference getVpnConnectionRef()

A reference to a VPNConnection resource.

Specified by:

getVpnConnectionRef in interface IVPNConnectionRef

getCustomerGatewayId

@Stability(Stable)
@NotNull
public String getCustomerGatewayId()

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

setCustomerGatewayId

@Stability(Stable)
public void setCustomerGatewayId(@NotNull
 String value)

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

getType

@Stability(Stable)
@NotNull
public String getType()

The type of VPN connection.

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

The type of VPN connection.

getEnableAcceleration

@Stability(Stable)
@Nullable
public Object getEnableAcceleration()

Indicate whether to enable acceleration for the VPN connection.

Returns union: either Boolean or IResolvable

setEnableAcceleration

@Stability(Stable)
public void setEnableAcceleration(@Nullable
 Boolean value)

Indicate whether to enable acceleration for the VPN connection.

setEnableAcceleration

@Stability(Stable)
public void setEnableAcceleration(@Nullable
 IResolvable value)

Indicate whether to enable acceleration for the VPN connection.

getLocalIpv4NetworkCidr

@Stability(Stable)
@Nullable
public String getLocalIpv4NetworkCidr()

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

setLocalIpv4NetworkCidr

@Stability(Stable)
public void setLocalIpv4NetworkCidr(@Nullable
 String value)

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

getLocalIpv6NetworkCidr

@Stability(Stable)
@Nullable
public String getLocalIpv6NetworkCidr()

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

setLocalIpv6NetworkCidr

@Stability(Stable)
public void setLocalIpv6NetworkCidr(@Nullable
 String value)

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

getOutsideIpAddressType

@Stability(Stable)
@Nullable
public String getOutsideIpAddressType()

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

setOutsideIpAddressType

@Stability(Stable)
public void setOutsideIpAddressType(@Nullable
 String value)

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

getPreSharedKeyStorage

@Stability(Stable)
@Nullable
public String getPreSharedKeyStorage()

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

setPreSharedKeyStorage

@Stability(Stable)
public void setPreSharedKeyStorage(@Nullable
 String value)

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

getRemoteIpv4NetworkCidr

@Stability(Stable)
@Nullable
public String getRemoteIpv4NetworkCidr()

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

setRemoteIpv4NetworkCidr

@Stability(Stable)
public void setRemoteIpv4NetworkCidr(@Nullable
 String value)

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

getRemoteIpv6NetworkCidr

@Stability(Stable)
@Nullable
public String getRemoteIpv6NetworkCidr()

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

setRemoteIpv6NetworkCidr

@Stability(Stable)
public void setRemoteIpv6NetworkCidr(@Nullable
 String value)

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

getStaticRoutesOnly

@Stability(Stable)
@Nullable
public Object getStaticRoutesOnly()

Indicates whether the VPN connection uses static routes only.

Returns union: either Boolean or IResolvable

setStaticRoutesOnly

@Stability(Stable)
public void setStaticRoutesOnly(@Nullable
 Boolean value)

Indicates whether the VPN connection uses static routes only.

setStaticRoutesOnly

@Stability(Stable)
public void setStaticRoutesOnly(@Nullable
 IResolvable value)

Indicates whether the VPN connection uses static routes only.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Any tags assigned to the VPN connection.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Any tags assigned to the VPN connection.

getTransitGatewayId

@Stability(Stable)
@Nullable
public String getTransitGatewayId()

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

setTransitGatewayId

@Stability(Stable)
public void setTransitGatewayId(@Nullable
 String value)

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

getTransportTransitGatewayAttachmentId

@Stability(Stable)
@Nullable
public String getTransportTransitGatewayAttachmentId()

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

setTransportTransitGatewayAttachmentId

@Stability(Stable)
public void setTransportTransitGatewayAttachmentId(@Nullable
 String value)

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

getTunnelBandwidth

@Stability(Stable)
@Nullable
public String getTunnelBandwidth()

setTunnelBandwidth

@Stability(Stable)
public void setTunnelBandwidth(@Nullable
 String value)

getTunnelInsideIpVersion

@Stability(Stable)
@Nullable
public String getTunnelInsideIpVersion()

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

setTunnelInsideIpVersion

@Stability(Stable)
public void setTunnelInsideIpVersion(@Nullable
 String value)

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

getVpnConcentratorId

@Stability(Stable)
@Nullable
public String getVpnConcentratorId()

setVpnConcentratorId

@Stability(Stable)
public void setVpnConcentratorId(@Nullable
 String value)

getVpnGatewayId

@Stability(Stable)
@Nullable
public String getVpnGatewayId()

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

setVpnGatewayId

@Stability(Stable)
public void setVpnGatewayId(@Nullable
 String value)

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

getVpnTunnelOptionsSpecifications

@Stability(Stable)
@Nullable
public Object getVpnTunnelOptionsSpecifications()

The tunnel options for the VPN connection.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnVPNConnection.VpnTunnelOptionsSpecificationProperty>

setVpnTunnelOptionsSpecifications

@Stability(Stable)
public void setVpnTunnelOptionsSpecifications(@Nullable
 IResolvable value)

The tunnel options for the VPN connection.

setVpnTunnelOptionsSpecifications

@Stability(Stable)
public void setVpnTunnelOptionsSpecifications(@Nullable
 List<Object> value)

The tunnel options for the VPN connection.