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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.381Z")
 @Stability(value=Stable)
public class CfnVPNConnection
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::VPNConnection`.

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
         .staticRoutesOnly(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transitGatewayId("transitGatewayId")
         .vpnGatewayId("vpnGatewayId")
         .vpnTunnelOptionsSpecifications(List.of(VpnTunnelOptionsSpecificationProperty.builder()
                 .preSharedKey("preSharedKey")
                 .tunnelInsideCidr("tunnelInsideCidr")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVPNConnection.Builder A fluent builder for CfnVPNConnection.
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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getCustomerGatewayId() The ID of the customer gateway at your end of the VPN connection.
Object	getStaticRoutesOnly() Indicates whether the VPN connection uses static routes only.
TagManager	getTags() Any tags assigned to the VPN connection.
String	getTransitGatewayId() The ID of the transit gateway associated with the VPN connection.
String	getType() The type of VPN connection.
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.
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	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	setTransitGatewayId(String value) The ID of the transit gateway associated with the VPN connection.
void	setType(String value) The type of VPN connection.
void	setVpnGatewayId(String value) The ID of the virtual private gateway at the AWS side of the VPN connection.
void	setVpnTunnelOptionsSpecifications(IResolvable value) The tunnel options for the VPN connection.
void	setVpnTunnelOptionsSpecifications(List<Object> value) The tunnel options for the VPN connection.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVPNConnection

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

CfnVPNConnection

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

CfnVPNConnection

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Any tags assigned to the VPN connection.

getCustomerGatewayId

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

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

setCustomerGatewayId

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

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

getType

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

The type of VPN connection.

setType

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

The type of VPN connection.

getStaticRoutesOnly

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

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 .

setStaticRoutesOnly

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

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 .

setStaticRoutesOnly

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

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 .

getTransitGatewayId

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

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

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

setTransitGatewayId

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

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

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

getVpnGatewayId

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

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.

setVpnGatewayId

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

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.

getVpnTunnelOptionsSpecifications

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

The tunnel options for the VPN connection.

setVpnTunnelOptionsSpecifications

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

The tunnel options for the VPN connection.

setVpnTunnelOptionsSpecifications

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

The tunnel options for the VPN connection.