Class CfnVPNConnection
A CloudFormation AWS::EC2::VPNConnection
.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnVPNConnection : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnVPNConnection
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::EC2::VPNConnection
Link: 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 cfnVPNConnection = new CfnVPNConnection(this, "MyCfnVPNConnection", new CfnVPNConnectionProps {
CustomerGatewayId = "customerGatewayId",
Type = "type",
// the properties below are optional
StaticRoutesOnly = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TransitGatewayId = "transitGatewayId",
VpnGatewayId = "vpnGatewayId",
VpnTunnelOptionsSpecifications = new [] { new VpnTunnelOptionsSpecificationProperty {
PreSharedKey = "preSharedKey",
TunnelInsideCidr = "tunnelInsideCidr"
} }
});
Synopsis
Constructors
CfnVPNConnection(Construct, String, ICfnVPNConnectionProps) | Create a new |
CfnVPNConnection(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnVPNConnection(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrVpnConnectionId | The ID of the VPN connection. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CustomerGatewayId | The ID of the customer gateway at your end 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. |
Type | The type of 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnVPNConnection(Construct, String, ICfnVPNConnectionProps)
Create a new AWS::EC2::VPNConnection
.
public CfnVPNConnection(Construct scope, string id, ICfnVPNConnectionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnVPNConnectionProps
- resource properties.
CfnVPNConnection(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnVPNConnection(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnVPNConnection(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnVPNConnection(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrVpnConnectionId
The ID of the VPN connection.
public virtual string AttrVpnConnectionId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VpnConnectionId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CustomerGatewayId
The ID of the customer gateway at your end of the VPN connection.
public virtual string CustomerGatewayId { get; set; }
Property Value
System.String
Remarks
StaticRoutesOnly
Indicates whether the VPN connection uses static routes only.
public virtual object StaticRoutesOnly { get; set; }
Property Value
System.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
.
Tags
Any tags assigned to the VPN connection.
public virtual TagManager Tags { get; }
Property Value
Remarks
TransitGatewayId
The ID of the transit gateway associated with the VPN connection.
public virtual string TransitGatewayId { get; set; }
Property Value
System.String
Remarks
You must specify either TransitGatewayId
or VpnGatewayId
, but not both.
Type
The type of VPN connection.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
VpnGatewayId
The ID of the virtual private gateway at the AWS side of the VPN connection.
public virtual string VpnGatewayId { get; set; }
Property Value
System.String
Remarks
You must specify either TransitGatewayId
or VpnGatewayId
, but not both.
VpnTunnelOptionsSpecifications
The tunnel options for the VPN connection.
public virtual object VpnTunnelOptionsSpecifications { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>