CfnVPNConnectionProps

class aws_cdk.aws_ec2.CfnVPNConnectionProps(*, customer_gateway_id, type, static_routes_only=None, tags=None, transit_gateway_id=None, vpn_gateway_id=None, vpn_tunnel_options_specifications=None)

Bases: object

Properties for defining a CfnVPNConnection.

Parameters
  • customer_gateway_id (str) – The ID of the customer gateway at your end of the VPN connection.

  • type (str) – The type of VPN connection.

  • static_routes_only (Union[bool, IResolvable, None]) – 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 .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Any tags assigned to the VPN connection.

  • transit_gateway_id (Optional[str]) – The ID of the transit gateway associated with the VPN connection. You must specify either TransitGatewayId or VpnGatewayId , but not both.

  • vpn_gateway_id (Optional[str]) – 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.

  • vpn_tunnel_options_specifications (Union[IResolvable, Sequence[Union[VpnTunnelOptionsSpecificationProperty, Dict[str, Any], IResolvable]], None]) – The tunnel options for the VPN connection.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_vPNConnection_props = ec2.CfnVPNConnectionProps(
    customer_gateway_id="customerGatewayId",
    type="type",

    # the properties below are optional
    static_routes_only=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    transit_gateway_id="transitGatewayId",
    vpn_gateway_id="vpnGatewayId",
    vpn_tunnel_options_specifications=[ec2.CfnVPNConnection.VpnTunnelOptionsSpecificationProperty(
        pre_shared_key="preSharedKey",
        tunnel_inside_cidr="tunnelInsideCidr"
    )]
)

Attributes

customer_gateway_id

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

Link

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

Return type

str

static_routes_only

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 .

Link

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

Return type

Union[bool, IResolvable, None]

tags

Any tags assigned to the VPN connection.

Link

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

Return type

Optional[List[CfnTag]]

transit_gateway_id

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

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

Link

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

Return type

Optional[str]

type

The type of VPN connection.

Link

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

Return type

str

vpn_gateway_id

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.

Link

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

Return type

Optional[str]

vpn_tunnel_options_specifications

The tunnel options for the VPN connection.

Link

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

Return type

Union[IResolvable, List[Union[VpnTunnelOptionsSpecificationProperty, IResolvable]], None]