DATASOURCE::VPC::CustomerGateway データソースリファレンス - Resource Orchestration Service

DATASOURCE::VPC::CustomerGateway は、カスタマーゲートウェイに関する情報をクエリするために使用されます。

構文

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

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

CustomerGatewayId

String

はい

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

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシーです。

有効な値:

Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

Description: カスタマーゲートウェイの説明です。
CustomerGatewayId: カスタマーゲートウェイの ID です。
CreateTime: カスタマーゲートウェイが作成された時刻です。単位: ミリ秒。
AuthKey: データセンター内のゲートウェイデバイスのボーダーゲートウェイプロトコル (BGP) ルーティングプロトコルの認証キーです。
IpAddress: データセンター内のゲートウェイデバイスのパブリック IP アドレスです。
Asn: データセンター内のゲートウェイデバイスの自律システム番号 (ASN) です。
CustomerGatewayName: カスタマーゲートウェイの名前です。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CustomerGatewayId:
    Description:
      en: The ID of the customer gateway.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      CustomerGatewayId:
        Ref: CustomerGatewayId
    Type: DATASOURCE::VPC::CustomerGateway
Outputs:
  Asn:
    Description: Asn.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Asn
  AuthKey:
    Description: The authentication key of the local data center gateway device BGP
      routing protocol.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AuthKey
  CreateTime:
    Description: The time when the customer gateway was created.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  CustomerGatewayId:
    Description: The ID of the customer gateway.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CustomerGatewayId
  CustomerGatewayName:
    Description: The name of the customer gateway.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CustomerGatewayName
  Description:
    Description: The description of the customer gateway.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Description
  IpAddress:
    Description: The IP address of the customer gateway.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IpAddress

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CustomerGatewayId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the customer gateway."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::CustomerGateway",
      "Properties": {
        "CustomerGatewayId": {
          "Ref": "CustomerGatewayId"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "カスタマーゲートウェイの説明です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "CustomerGatewayId": {
      "Description": "カスタマーゲートウェイの ID です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CustomerGatewayId"
        ]
      }
    },
    "CreateTime": {
      "Description": "カスタマーゲートウェイが作成された時刻です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "AuthKey": {
      "Description": "ローカルデータセンターゲートウェイデバイス BGP ルーティングプロトコルの認証キーです。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AuthKey"
        ]
      }
    },
    "IpAddress": {
      "Description": "カスタマーゲートウェイの IP アドレスです。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IpAddress"
        ]
      }
    },
    "Asn": {
      "Description": "Asn です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Asn"
        ]
      }
    },
    "CustomerGatewayName": {
      "Description": "カスタマーゲートウェイの名前です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CustomerGatewayName"
        ]
      }
    }
  }
}