AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::EC2::VPNConnection

在现有虚拟私有网关和 VPN 客户网关之间创建新的 VPN 连接。

有关详细信息,请参阅 Amazon EC2 API Reference 中的 CreateVpnConnection 部分。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

Copy
{ "Type" : "AWS::EC2::VPNConnection", "Properties" : { "Type" : String, "CustomerGatewayId" : GatewayID, "StaticRoutesOnly" : Boolean, "Tags" : [ Resource Tag, ... ], "VpnGatewayId" : GatewayID } }

YAML

Copy
Type: "AWS::EC2::VPNConnection" Properties: Type: String CustomerGatewayId: GatewayID StaticRoutesOnly: Boolean Tags: - Resource Tag VpnGatewayId: GatewayID

属性

Type

此虚拟私有网关支持的 VPN 连接类型。

实例:"ipsec.1"

必需:是

类型:字符串

更新要求替换

CustomerGatewayId

客户网关的 ID。此 ID 既可能是嵌入式 JSON 数据元也可能是网关 ID 的引用。

必需:是

类型:字符串

更新要求替换

StaticRoutesOnly

指明 VPN 连接是否要求使用静态路由。

必需:有条件的。如果您要为不支持边界网关协议 (BGP) 的设备创建 VPN 连接,则必须指定 true

类型:布尔值

更新要求替换

Tags

需要附加到资源的标签。

Required: No

类型AWS CloudFormation 资源标签

更新要求无需中断

VpnGatewayId

虚拟私有网关的 ID。此 ID 既可能是嵌入式 JSON 数据元也可能是网关 ID 的引用。

必需:是

类型:字符串

更新要求替换

返回值

当该资源的逻辑 ID 提供给 Ref内部函数时,Ref 将返回资源名称。 示例:

Copy
{ "Ref": "MyVPNConnection" }

对于逻辑 ID 为“MyVPNConnection”的 VPNConnection,Ref 会返回 VPN 连接的资源名称。

有关使用 Ref 功能的更多信息,请参阅参考

模板示例

JSON

Copy
{ "AWSTemplateFormatVersion" : "2010-09-09", "Resources" : { "myVPNConnection" : { "Type" : "AWS::EC2::VPNConnection", "Properties" : { "Type" : "ipsec.1", "StaticRoutesOnly" : "true", "CustomerGatewayId" : {"Ref" : "myCustomerGateway"}, "VpnGatewayId" : {"Ref" : "myVPNGateway"} } } } }

YAML

Copy
AWSTemplateFormatVersion: "2010-09-09" Resources: myVPNConnection: Type: "AWS::EC2::VPNConnection" Properties: Type: ipsec.1 StaticRoutesOnly: true CustomerGatewayId: !Ref myCustomerGateway VpnGatewayId: !Ref myVPNGateway