Class CfnVPNConnectionProps

Properties for defining a CfnVPNConnection.

Inheritance

object

CfnVPNConnectionProps

Implements

ICfnVPNConnectionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnVPNConnectionProps : ICfnVPNConnectionProps

Syntax (vb)

Public Class CfnVPNConnectionProps Implements ICfnVPNConnectionProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnVPNConnectionProps = new CfnVPNConnectionProps {
                 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 = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TransitGatewayId = "transitGatewayId",
                 TransportTransitGatewayAttachmentId = "transportTransitGatewayAttachmentId",
                 TunnelBandwidth = "tunnelBandwidth",
                 TunnelInsideIpVersion = "tunnelInsideIpVersion",
                 VpnConcentratorId = "vpnConcentratorId",
                 VpnGatewayId = "vpnGatewayId",
                 VpnTunnelOptionsSpecifications = new [] { new VpnTunnelOptionsSpecificationProperty {
                     DpdTimeoutAction = "dpdTimeoutAction",
                     DpdTimeoutSeconds = 123,
                     EnableTunnelLifecycleControl = false,
                     IkeVersions = new [] { new Dictionary<string, string?> {
                         { "value", "value" }
                     } },
                     LogOptions = new VpnTunnelLogOptionsSpecificationProperty {
                         CloudwatchLogOptions = new CloudwatchLogOptionsSpecificationProperty {
                             BgpLogEnabled = false,
                             BgpLogGroupArn = "bgpLogGroupArn",
                             BgpLogOutputFormat = "bgpLogOutputFormat",
                             LogEnabled = false,
                             LogGroupArn = "logGroupArn",
                             LogOutputFormat = "logOutputFormat"
                         }
                     },
                     Phase1DhGroupNumbers = new [] { new Phase1DHGroupNumbersRequestListValueProperty {
                         Value = 123
                     } },
                     Phase1EncryptionAlgorithms = new [] { new Phase1EncryptionAlgorithmsRequestListValueProperty {
                         Value = "value"
                     } },
                     Phase1IntegrityAlgorithms = new [] { new Phase1IntegrityAlgorithmsRequestListValueProperty {
                         Value = "value"
                     } },
                     Phase1LifetimeSeconds = 123,
                     Phase2DhGroupNumbers = new [] { new Phase2DHGroupNumbersRequestListValueProperty {
                         Value = 123
                     } },
                     Phase2EncryptionAlgorithms = new [] { new Phase2EncryptionAlgorithmsRequestListValueProperty {
                         Value = "value"
                     } },
                     Phase2IntegrityAlgorithms = new [] { new Phase2IntegrityAlgorithmsRequestListValueProperty {
                         Value = "value"
                     } },
                     Phase2LifetimeSeconds = 123,
                     PreSharedKey = "preSharedKey",
                     RekeyFuzzPercentage = 123,
                     RekeyMarginTimeSeconds = 123,
                     ReplayWindowSize = 123,
                     StartupAction = "startupAction",
                     TunnelInsideCidr = "tunnelInsideCidr",
                     TunnelInsideIpv6Cidr = "tunnelInsideIpv6Cidr"
                 } }
             };

Synopsis

Constructors

CfnVPNConnectionProps()

Properties for defining a CfnVPNConnection.

Properties

CustomerGatewayId	The ID of the customer gateway at your end of the VPN connection.
EnableAcceleration	Indicate whether to enable acceleration for the VPN connection.
LocalIpv4NetworkCidr	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
LocalIpv6NetworkCidr	The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
OutsideIpAddressType	The type of IP address assigned to the outside interface of the customer gateway device.
PreSharedKeyStorage	Describes the storage location for an instance store-backed AMI.
RemoteIpv4NetworkCidr	The IPv4 CIDR on the AWS side of the VPN connection.
RemoteIpv6NetworkCidr	The IPv6 CIDR on the AWS side of the VPN connection.
StaticRoutesOnly	Indicates whether the VPN connection uses static routes only.
Tags	Any tags assigned to the VPN connection.
TransitGatewayId	The ID of the transit gateway associated with the VPN connection.
TransportTransitGatewayAttachmentId	The transit gateway attachment ID to use for the VPN tunnel.
TunnelBandwidth	The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity.
TunnelInsideIpVersion	Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Type	The type of VPN connection.
VpnConcentratorId	The ID of the VPN concentrator to associate with the VPN connection.
VpnGatewayId	The ID of the virtual private gateway at the AWS side of the VPN connection.
VpnTunnelOptionsSpecifications	The tunnel options for the VPN connection.

Constructors

CfnVPNConnectionProps()

Properties for defining a CfnVPNConnection.

public CfnVPNConnectionProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnVPNConnectionProps = new CfnVPNConnectionProps {
                 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 = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TransitGatewayId = "transitGatewayId",
                 TransportTransitGatewayAttachmentId = "transportTransitGatewayAttachmentId",
                 TunnelBandwidth = "tunnelBandwidth",
                 TunnelInsideIpVersion = "tunnelInsideIpVersion",
                 VpnConcentratorId = "vpnConcentratorId",
                 VpnGatewayId = "vpnGatewayId",
                 VpnTunnelOptionsSpecifications = new [] { new VpnTunnelOptionsSpecificationProperty {
                     DpdTimeoutAction = "dpdTimeoutAction",
                     DpdTimeoutSeconds = 123,
                     EnableTunnelLifecycleControl = false,
                     IkeVersions = new [] { new Dictionary<string, string?> {
                         { "value", "value" }
                     } },
                     LogOptions = new VpnTunnelLogOptionsSpecificationProperty {
                         CloudwatchLogOptions = new CloudwatchLogOptionsSpecificationProperty {
                             BgpLogEnabled = false,
                             BgpLogGroupArn = "bgpLogGroupArn",
                             BgpLogOutputFormat = "bgpLogOutputFormat",
                             LogEnabled = false,
                             LogGroupArn = "logGroupArn",
                             LogOutputFormat = "logOutputFormat"
                         }
                     },
                     Phase1DhGroupNumbers = new [] { new Phase1DHGroupNumbersRequestListValueProperty {
                         Value = 123
                     } },
                     Phase1EncryptionAlgorithms = new [] { new Phase1EncryptionAlgorithmsRequestListValueProperty {
                         Value = "value"
                     } },
                     Phase1IntegrityAlgorithms = new [] { new Phase1IntegrityAlgorithmsRequestListValueProperty {
                         Value = "value"
                     } },
                     Phase1LifetimeSeconds = 123,
                     Phase2DhGroupNumbers = new [] { new Phase2DHGroupNumbersRequestListValueProperty {
                         Value = 123
                     } },
                     Phase2EncryptionAlgorithms = new [] { new Phase2EncryptionAlgorithmsRequestListValueProperty {
                         Value = "value"
                     } },
                     Phase2IntegrityAlgorithms = new [] { new Phase2IntegrityAlgorithmsRequestListValueProperty {
                         Value = "value"
                     } },
                     Phase2LifetimeSeconds = 123,
                     PreSharedKey = "preSharedKey",
                     RekeyFuzzPercentage = 123,
                     RekeyMarginTimeSeconds = 123,
                     ReplayWindowSize = 123,
                     StartupAction = "startupAction",
                     TunnelInsideCidr = "tunnelInsideCidr",
                     TunnelInsideIpv6Cidr = "tunnelInsideIpv6Cidr"
                 } }
             };

Properties

CustomerGatewayId

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

public object CustomerGatewayId { get; set; }

Property Value

object

Remarks

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

Type union: either string or ICustomerGatewayRef

EnableAcceleration

Indicate whether to enable acceleration for the VPN connection.

public object? EnableAcceleration { get; set; }

Property Value

object

Remarks

Default: false

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

Type union: either bool or IResolvable

LocalIpv4NetworkCidr

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

public string? LocalIpv4NetworkCidr { get; set; }

Property Value

string

Remarks

Default: 0.0.0.0/0

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

LocalIpv6NetworkCidr

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

public string? LocalIpv6NetworkCidr { get; set; }

Property Value

string

Remarks

Default: ::/0

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

OutsideIpAddressType

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

public string? OutsideIpAddressType { get; set; }

Property Value

string

Remarks

Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

Default: PublicIpv4

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

PreSharedKeyStorage

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

public string? PreSharedKeyStorage { get; set; }

Property Value

string

Remarks

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

RemoteIpv4NetworkCidr

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

public string? RemoteIpv4NetworkCidr { get; set; }

Property Value

string

Remarks

Default: 0.0.0.0/0

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

RemoteIpv6NetworkCidr

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

public string? RemoteIpv6NetworkCidr { get; set; }

Property Value

string

Remarks

Default: ::/0

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

StaticRoutesOnly

Indicates whether the VPN connection uses static routes only.

public object? StaticRoutesOnly { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#cfn-ec2-vpnconnection-staticroutesonly

Type union: either bool or IResolvable

Tags

Any tags assigned to the VPN connection.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

TransitGatewayId

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

public object? TransitGatewayId { get; set; }

Property Value

object

Remarks

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

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

Type union: either string or ITransitGatewayRef

TransportTransitGatewayAttachmentId

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

public string? TransportTransitGatewayAttachmentId { get; set; }

Property Value

string

Remarks

Required if OutsideIpAddressType is set to PrivateIpv4 .

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

TunnelBandwidth

The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity.

public string? TunnelBandwidth { get; set; }

Property Value

string

Remarks

standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. The default value is standard . Existing VPN connections without a bandwidth setting will automatically default to standard .

Default: - "standard"

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

TunnelInsideIpVersion

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

public string? TunnelInsideIpVersion { get; set; }

Property Value

string

Remarks

Default: ipv4

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

Type

The type of VPN connection.

public string Type { get; set; }

Property Value

string

Remarks

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

VpnConcentratorId

The ID of the VPN concentrator to associate with the VPN connection.

public string? VpnConcentratorId { get; set; }

Property Value

string

Remarks

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

VpnGatewayId

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

public object? VpnGatewayId { get; set; }

Property Value

object

Remarks

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

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

Type union: either string or IVPNGatewayRef

VpnTunnelOptionsSpecifications

The tunnel options for the VPN connection.

public object? VpnTunnelOptionsSpecifications { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnVPNConnection.IVpnTunnelOptionsSpecificationProperty)[]

Implements

ICfnVPNConnectionProps