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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:55:56.824Z")
@Stability(Stable)
public class CfnVPNConnection
extends CfnResource
implements IInspectable, 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") .remoteIpv4NetworkCidr("remoteIpv4NetworkCidr") .remoteIpv6NetworkCidr("remoteIpv6NetworkCidr") .staticRoutesOnly(false) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .transitGatewayId("transitGatewayId") .transportTransitGatewayAttachmentId("transportTransitGatewayAttachmentId") .tunnelInsideIpVersion("tunnelInsideIpVersion") .vpnGatewayId("vpnGatewayId") .vpnTunnelOptionsSpecifications(List.of(VpnTunnelOptionsSpecificationProperty.builder() .preSharedKey("preSharedKey") .tunnelInsideCidr("tunnelInsideCidr") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnVPNConnection
.static interface
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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnVPNConnection
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnVPNConnection
(software.amazon.jsii.JsiiObjectRef objRef) CfnVPNConnection
(software.constructs.Construct scope, String id, CfnVPNConnectionProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ID of the VPN connection.The ID of the customer gateway at your end of the VPN connection.Indicate whether to enable acceleration for the VPN connection.The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.The type of IPv4 address assigned to the outside interface of the customer gateway device.The IPv4 CIDR on the AWS side of the VPN connection.The IPv6 CIDR on the AWS side of the VPN connection.Indicates whether the VPN connection uses static routes only.getTags()
Tag Manager which manages the tags for this resource.Any tags assigned to the VPN connection.The ID of the transit gateway associated with the VPN connection.The transit gateway attachment ID to use for the VPN tunnel.Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.getType()
The type of VPN connection.The ID of the virtual private gateway at the AWS side of the VPN connection.The tunnel options for the VPN connection.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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 IPv4 address assigned to the outside interface of the customer gateway device.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
The transit gateway attachment ID to use for the VPN tunnel.void
setTunnelInsideIpVersion
(String value) Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.void
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
The tunnel options for the VPN connection.void
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, 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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrVpnConnectionId
The ID of the VPN connection. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getCustomerGatewayId
The ID of the customer gateway at your end of the VPN connection. -
setCustomerGatewayId
The ID of the customer gateway at your end of the VPN connection. -
getType
The type of VPN connection. -
setType
The type of VPN connection. -
getEnableAcceleration
Indicate whether to enable acceleration for the VPN connection. -
setEnableAcceleration
Indicate whether to enable acceleration for the VPN connection. -
setEnableAcceleration
Indicate whether to enable acceleration for the VPN connection. -
getLocalIpv4NetworkCidr
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. -
setLocalIpv4NetworkCidr
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. -
getLocalIpv6NetworkCidr
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. -
setLocalIpv6NetworkCidr
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. -
getOutsideIpAddressType
The type of IPv4 address assigned to the outside interface of the customer gateway device. -
setOutsideIpAddressType
The type of IPv4 address assigned to the outside interface of the customer gateway device. -
getRemoteIpv4NetworkCidr
The IPv4 CIDR on the AWS side of the VPN connection. -
setRemoteIpv4NetworkCidr
The IPv4 CIDR on the AWS side of the VPN connection. -
getRemoteIpv6NetworkCidr
The IPv6 CIDR on the AWS side of the VPN connection. -
setRemoteIpv6NetworkCidr
The IPv6 CIDR on the AWS side of the VPN connection. -
getStaticRoutesOnly
Indicates whether the VPN connection uses static routes only. -
setStaticRoutesOnly
Indicates whether the VPN connection uses static routes only. -
setStaticRoutesOnly
Indicates whether the VPN connection uses static routes only. -
getTagsRaw
Any tags assigned to the VPN connection. -
setTagsRaw
Any tags assigned to the VPN connection. -
getTransitGatewayId
The ID of the transit gateway associated with the VPN connection. -
setTransitGatewayId
The ID of the transit gateway associated with the VPN connection. -
getTransportTransitGatewayAttachmentId
The transit gateway attachment ID to use for the VPN tunnel. -
setTransportTransitGatewayAttachmentId
The transit gateway attachment ID to use for the VPN tunnel. -
getTunnelInsideIpVersion
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. -
setTunnelInsideIpVersion
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. -
getVpnGatewayId
The ID of the virtual private gateway at the AWS side of the VPN connection. -
setVpnGatewayId
The ID of the virtual private gateway at the AWS side of the VPN connection. -
getVpnTunnelOptionsSpecifications
The tunnel options for the VPN connection. -
setVpnTunnelOptionsSpecifications
The tunnel options for the VPN connection. -
setVpnTunnelOptionsSpecifications
The tunnel options for the VPN connection.
-