メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::EC2::VPNConnection

既存の仮想プライベートゲートウェイと VPN カスタマーゲートウェイの間に新しい VPN 接続を作成します。

詳細については、Amazon EC2 API ReferenceCreateVpnConnection を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

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

プロパティ

Type

この仮想プライベートゲートウェイがサポートする VPN 接続のタイプ。

例: "ipsec.1"

必須: はい

タイプ: 文字列

更新に伴う要件: 置換

CustomerGatewayId

カスタマーゲートウェイの ID。埋め込み JSON オブジェクトまたはゲートウェイ ID の参照を指定できます。

必須: はい

タイプ: 文字列

更新に伴う要件: 置換

StaticRoutesOnly

VPN 接続で静的ルートを必要とするかどうかを示します。

必須: 条件による。ボーダーゲートウェイプロトコル (BGP) をサポートしないデバイスの VPN 接続を作成する場合は、true を指定する必要があります。

タイプ: ブール値

更新に伴う要件: 置換

Tags

リソースにアタッチするタグ。

Required: No

: AWS CloudFormation Resource Tags

更新に伴う要件: 中断はありません。

VpnGatewayId

仮想プライベートゲートウェイの ID。埋め込み JSON オブジェクトまたはゲートウェイ ID の参照を指定できます。

必須: はい

タイプ: 文字列

更新に伴う要件: 置換

VpnTunnelOptionsSpecifications

VPN 接続のトンネルオプション。 重複は許可されません。

必須: いいえ

: EC2 VPNConnection VpnTunnelOptionsSpecification のリスト

更新に伴う要件: 置換。

戻り値

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。 例:

Copy
{ "Ref": "MyVPNConnection" }

論理 ID が "MyVPNConnection" の VPNConnection に対し、Ref は VPN 接続のリソース名を返します。

Ref 関数の使用方法の詳細については、「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

以下の資料も参照してください。