Package software.amazon.awscdk.services.ec2

Interface CfnVPNConnectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVPNConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:00.813Z")
@Stability(Stable)
public interface CfnVPNConnectionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVPNConnection.

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.*;
 CfnVPNConnectionProps cfnVPNConnectionProps = CfnVPNConnectionProps.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVPNConnectionProps.Builder	A builder for CfnVPNConnectionProps
static final class	CfnVPNConnectionProps.Jsii$Proxy	An implementation for CfnVPNConnectionProps

Method Summary

Modifier and Type	Method	Description
static CfnVPNConnectionProps.Builder	builder()
String	getCustomerGatewayId()	The ID of the customer gateway at your end of the VPN connection.
default Object	getStaticRoutesOnly()	Indicates whether the VPN connection uses static routes only.
default List<CfnTag>	getTags()	Any tags assigned to the VPN connection.
default String	getTransitGatewayId()	The ID of the transit gateway associated with the VPN connection.
String	getType()	The type of VPN connection.
default String	getVpnGatewayId()	The ID of the virtual private gateway at the AWS side of the VPN connection.
default Object	getVpnTunnelOptionsSpecifications()	The tunnel options for the VPN connection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomerGatewayId

@Stability(Stable)
@NotNull
String getCustomerGatewayId()

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

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of VPN connection.

See Also:

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

getStaticRoutesOnly

@Stability(Stable)
@Nullable
default 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 .

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Any tags assigned to the VPN connection.

See Also:

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

getTransitGatewayId

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

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

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

See Also:

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

getVpnGatewayId

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getVpnTunnelOptionsSpecifications

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

The tunnel options for the VPN connection.

See Also:

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

builder

@Stability(Stable)
static CfnVPNConnectionProps.Builder builder()

Returns:

a CfnVPNConnectionProps.Builder of CfnVPNConnectionProps