AWS::EC2::VPNConnection
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 Amazon Site-to-Site VPN in the Amazon Site-to-Site VPN User Guide.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::EC2::VPNConnection", "Properties" : { "CustomerGatewayId" :
String
, "StaticRoutesOnly" :Boolean
, "Tags" :[ Tag, ... ]
, "TransitGatewayId" :String
, "Type" :String
, "VpnGatewayId" :String
, "VpnTunnelOptionsSpecifications" :[ VpnTunnelOptionsSpecification, ... ]
} }
YAML
Type: AWS::EC2::VPNConnection Properties: CustomerGatewayId:
String
StaticRoutesOnly:Boolean
Tags:- Tag
TransitGatewayId:String
Type:String
VpnGatewayId:String
VpnTunnelOptionsSpecifications:- VpnTunnelOptionsSpecification
Properties
CustomerGatewayId
-
The ID of the customer gateway at your end of the VPN connection.
Required: Yes
Type: String
Update requires: Replacement
StaticRoutesOnly
-
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
.Required: No
Type: Boolean
Update requires: Replacement
-
Any tags assigned to the VPN connection.
Required: No
Type: Array of Tag
Update requires: No interruption
TransitGatewayId
-
The ID of the transit gateway associated with the VPN connection.
You must specify either
TransitGatewayId
orVpnGatewayId
, but not both.Required: Conditional
Type: String
Update requires: Replacement
Type
-
The type of VPN connection.
Required: Yes
Type: String
Allowed values:
ipsec.1
Update requires: Replacement
VpnGatewayId
-
The ID of the virtual private gateway at the Amazon side of the VPN connection.
You must specify either
TransitGatewayId
orVpnGatewayId
, but not both.Required: Conditional
Type: String
Update requires: Replacement
VpnTunnelOptionsSpecifications
-
The tunnel options for the VPN connection.
Required: No
Type: Array of VpnTunnelOptionsSpecification
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the ID of the VPN connection.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
VpnConnectionId
-
The ID of the VPN connection.
Examples
VPN connection
The following example specifies a VPN connection between myVPNGateway and MyCustomerGateway.
JSON
"myVPNConnection" : { "Type" : "AWS::EC2::VPNConnection", "Properties" : { "Type" : "ipsec.1", "StaticRoutesOnly" : "true", "CustomerGatewayId" : {"Ref" : "myCustomerGateway"}, "VpnGatewayId" : {"Ref" : "myVPNGateway"} } }
YAML
myVPNConnection: Type: AWS::EC2::VPNConnection Properties: Type: ipsec.1 StaticRoutesOnly: true CustomerGatewayId: !Ref myCustomerGateway VpnGatewayId: !Ref myVPNGateway
See also
-
VPNConnection in the Amazon EC2 API Reference