AWS::EC2::ClientVpnRoute

クライアント VPN エンドポイントに追加するネットワークルートを指定します。各クライアント VPN エンドポイントには、利用可能な送信先ネットワークルートを説明したルートテーブルがあります。ルートテーブル内の各ルートは、特定のリソースまたはネットワークへのトラフィックのパスを指定します。

ルートを指定する前に、ターゲットのネットワーク関連付けを作成する必要があります。Client VPN エンドポイントのすべてのコンポーネントを同時にセットアップする場合は、DependsOn 属性 を使用して AWS::EC2::ClientVpnTargetNetworkAssociation リソースへの依存関係を宣言する必要があります。

構文

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

JSON

{
  "Type" : "AWS::EC2::ClientVpnRoute",
  "Properties" : {
      "ClientVpnEndpointId" : String,
      "Description" : String,
      "DestinationCidrBlock" : String,
      "TargetVpcSubnetId" : String
    }
}

YAML

Type: AWS::EC2::ClientVpnRoute
Properties: 
  ClientVpnEndpointId: String
  Description: String
  DestinationCidrBlock: String
  TargetVpcSubnetId: String

プロパティ

ClientVpnEndpointId

ルートを追加するクライアント VPN エンドポイントの ID。

必須: はい

タイプ: 文字列

Update requires: Replacement

Description

ルートに関する簡単な説明。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

DestinationCidrBlock

ルート送信先の CIDR 表記の IPv4 アドレス範囲。次に例を示します。

• インターネット接続用のルートを追加するには、「0.0.0.0/0」を入力します。

• ピア接続 VPC 用のルートを追加するには、ピア接続 VPC の IPv4 CIDR 範囲を入力します。

• オンプレミスネットワーク用のルートを追加するには、AWS Site-to-Site VPN 接続の IPv4 CIDR 範囲を入力します。

• ローカルネットワークのルートを追加するには、クライアントの CIDR 範囲を入力します。

必須: はい

タイプ: 文字列

Update requires: Replacement

TargetVpcSubnetId

トラフィックのルーティングに使用するサブネットの ID。指定されたサブネットは、クライアント VPN エンドポイントの既存のターゲットネットワークである必要があります。

または、ローカルネットワークのルートを追加する場合は、local を指定します。

必須: はい

タイプ: 文字列

Update requires: Replacement

例

クライアント VPN エンドポイントにルートを追加する

次の例では、インターネットアクセスのルートをクライアント VPN エンドポイントに追加します。

YAML

myRoute:
  Type: "AWS::EC2::ClientVpnRoute"
  Properties:
    ClientVpnEndpointId: 
      Ref: myClientVpnEndpoint
    TargetVpcSubnetId: 
      Ref: mySubnet
    DestinationCidrBlock: "0.0.0.0/0"
    Description: "myRoute"

JSON

"myRoute": {
    "Type": "AWS::EC2::ClientVpnRoute",
    "Properties": {
        "ClientVpnEndpointId": {
            "Ref": "myClientVpnEndpoint"
        },
        "TargetVpcSubnetId": {
            "Ref": "mySubnet"
        },
        "DestinationCidrBlock": "0.0.0.0/0",
        "Description": "myRoute"
    }
}

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

• AWS Client VPN 管理者ガイドの「クライアント VPN の開始方法」

• AWS Client VPN 管理者ガイドの「ルート」