DATASOURCE::VPC::CustomerGateways を使用したカスタマーゲートウェイのクエリ - ROS

DATASOURCE::VPC::CustomerGateways は、カスタマーゲートウェイを照会するために使用されます。

構文

{
  "Type": "DATASOURCE::VPC::CustomerGateways",
  "Properties": {
    "CustomerGatewayId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

CustomerGatewayId

String

いいえ

はい

カスタマーゲートウェイの ID。

なし。

RefreshOptions

String

いいえ

はい

スタックが更新されたときのデータソースリソースの更新ポリシー。

有効な値：

Never（デフォルト）：スタックが更新されたときにデータソースリソースを更新しません。
Always：スタックが更新されたときにデータソースリソースを更新します。

戻り値

Fn::GetAtt

CustomerGateways：カスタマーゲートウェイの詳細。
CustomerGatewayIds：カスタマーゲートウェイの ID。

プロパティ	タイプ	説明	制約
CustomerGatewayIds	List	カスタマーゲートウェイの ID。	なし。
CustomerGateways	List	カスタマーゲートウェイの詳細。	なし。
CustomerGatewayName	String	カスタマーゲートウェイの名前。	なし。
Description	String	カスタマーゲートウェイの説明。	なし。
Asn	Number	データセンター内のゲートウェイデバイスの自律システム番号（ ASN）。	なし。
AuthKey	String	データセンター内のゲートウェイデバイスの Border Gateway Protocol（ BGP）ルーティングプロトコルの認証キー。	なし。
CustomerGatewayId	String	カスタマーゲートウェイの ID。	なし。
IpAddress	String	データセンター内のゲートウェイデバイスのパブリック IP アドレス。	なし。
CreateTime	String	カスタマーゲートウェイが作成されたときに生成されたタイムスタンプ。	単位：ミリ秒。この値は、エポックタイム 1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CustomerGatewayId:
    Description: カスタマーゲートウェイの ID。
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      CustomerGatewayId:
        Ref: CustomerGatewayId
    Type: DATASOURCE::VPC::CustomerGateways
Outputs:
  CustomerGatewayIds:
    Description: カスタマーゲートウェイ ID のリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CustomerGatewayIds
  CustomerGateways:
    Description: カスタマーゲートウェイのリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CustomerGateways

JSON

JSON format
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CustomerGatewayId": {
      "Type": "String",
      "Description": "カスタマーゲートウェイの ID。"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::CustomerGateways",
      "Properties": {
        "CustomerGatewayId": {
          "Ref": "CustomerGatewayId"
        }
      }
    }
  },
  "Outputs": {
    "CustomerGateways": {
      "Description": "カスタマーゲートウェイのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CustomerGateways"
        ]
      }
    },
    "CustomerGatewayIds": {
      "Description": "カスタマーゲートウェイ ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CustomerGatewayIds"
        ]
      }
    }
  }
}