DATASOURCE::VPC::RouteEntries の概要 - ROS

DATASOURCE::VPC::RouteEntries は、ルートをクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::VPC::RouteEntries",
  "Properties": {
    "NextHopType": String,
    "RouteEntryId": String,
    "RouteTableId": String,
    "IpVersion": String,
    "RouteEntryName": String,
    "RouteEntryType": String,
    "NextHopId": String,
    "DestinationCidrBlock": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
NextHopType	String	いいえ	はい	ネクストホップのタイプ。	有効な値： Instance（デフォルト）：Elastic Compute Service（ECS）インスタンス HaVip：高可用性仮想 IP アドレス（HAVIP） VpnGateway：VPN ゲートウェイ NatGateway：NAT ゲートウェイ NetworkInterface：セカンダリ Elastic Network Interface（ENI） RouterInterface：ルーターインターフェース IPv6Gateway：IPv6 ゲートウェイ Attachment：トランジットルーター
RouteEntryId	String	いいえ	はい	ルート ID。	なし。
RouteTableId	String	はい	はい	ルートテーブルの ID。	なし。
IpVersion	String	いいえ	はい	プロトコルの IP バージョン。	有効な値： IPv4 IPv6
RouteEntryName	String	いいえ	はい	ルート名。	なし。
RouteEntryType	String	いいえ	はい	ルートタイプ。	有効な値： Custom：カスタムルート System：システムルート BGP：BGP ルート CEN：Cloud Enterprise Network（CEN）ルート
NextHopId	String	いいえ	はい	ネクストホップの ID。	なし。
DestinationCidrBlock	String	いいえ	はい	ルートの宛先 CIDR ブロック。	IPv4 および IPv6 CIDR ブロックがサポートされています。例：192.168.2.0/24。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値： Never（デフォルト）：スタックが更新されたときにデータソースリソースを更新しません。 Always：スタックが更新されたときにデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

RouteEntryIds：ルートの ID。
RouteEntries：ルートの詳細。

プロパティ	タイプ	説明	制約
RouteEntryIds	List	ルートの ID。	例：`['rte-bp1mnnr2al0naomnp**', 'rte-hu2mnnr3al0naomnp**']`。
RouteEntries	List	ルートの詳細。	なし。
Status	String	ルートステータス。	有効な値： Pending：ルートは設定中です。 Available：ルートは使用可能です。 Modifying：ルートは変更中です。
Type	String	ルートタイプ。	有効な値： Custom：カスタムルート System：システムルート BGP：BGP ルート CEN：CEN ルート
IpVersion	String	プロトコルの IP バージョン。	有効な値： IPv4 IPv6
Description	String	ルートの説明。	なし。
RouteEntryName	String	ルート名。	なし。
DestinationCidrBlock	String	ルートの宛先 CIDR ブロック。	なし。
RouteEntryId	String	ルート ID。	なし。
RouteTableId	String	ルートテーブルの ID。	なし。
NextHops	List	ネクストホップの詳細。	例：`[ { "NextHopId": "eni-bp16v0fuhulfl5e1****", "NextHopRelatedInfo": {}, "NextHopType": "NetworkInterface" }]`。

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RouteTableId": {
      "Type": "String",
      "Description": "ルートのID。" // The ID of the route.
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::RouteEntries",
      "Properties": {
        "RouteTableId": {
          "Ref": "RouteTableId"
        }
      }
    }
  },
  "Outputs": {
    "RouteEntries": {
      "Description": "ルートエントリのリスト。", // The list of The route entries.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteEntries"
        ]
      }
    },
    "RouteEntryIds": {
      "Description": "ルートエントリ ID のリスト。", // the list of the route entry ids.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteEntryIds"
        ]
      }
    }
  }
}