DATASOURCE::VPC::BgpPeers リソース（ROS BGP ピア取得）- ROS

DATASOURCE::VPC::BgpPeers は、リージョン内のボーダーゲートウェイプロトコル (BGP) ピアをクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::VPC::BgpPeers",
  "Properties": {
    "BgpPeerId": String,
    "BgpGroupId": String,
    "RouterId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
BgpPeerId	String	いいえ	はい	BGP ピアの ID。	なし。
BgpGroupId	String	いいえ	はい	BGP ピアが属する BGP グループの ID。	なし。
RouterId	String	いいえ	はい	ルーターの ID。	なし。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースのリフレッシュポリシー。	有効な値: Never (デフォルト): スタックが更新されたときにデータソースリソースをリフレッシュしません。 Always: スタックが更新されたときにデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

BgpPeerIds: BGP ピアの ID。
BgpPeers: BGP ピアの詳細。

プロパティ	タイプ	説明	制約
BgpPeerIds	List	BGP ピアの ID。	なし。
BgpPeers	List	BGP ピアの詳細。	なし。
Status	String	BGP ピアのステータス。	なし。
PeerIpAddress	String	BGP ピアの IP アドレス。	なし。
RouterId	Number	ルーターの ID。	なし。
BgpGroupId	String	BGP グループの ID。	なし。
BgpStatus	String	BGP 接続のステータス。	有効な値: Idle: 接続が確立されていません。 Connect: 接続が使用されています。 Active: 接続が利用可能です。 Established: 接続が確立されています。 Down: 接続が利用できません。
BfdMultiHop	String	双方向転送検出 (BFD) ホップの数。	なし。
PeerAsn	String	BGP ピアの自律システム番号 (ASN)。	なし。
LocalAsn	String	Alibaba Cloud 側のデバイスの ASN。	なし。
BgpPeerId	String	BGP ピアの ID。	なし。
EnableBfd	String	BFD が有効になっているかどうかを示します。	有効な値: true: BFD が有効です。 false: BFD が無効です。
Hold	String	BGP メッセージを受信するために使用されるホールド時間。単位: 秒。	なし。
IpVersion	String	IP バージョン。	なし。
Keepalive	String	キープアライブ時間。単位: 秒。	なし。
Description	String	BGP グループの説明。	なし。
RouteLimit	String	ルートの制限。	なし。
IsFake	String	偽の ASN が使用されているかどうかを示します。	有効な値: true: 偽の ASN が使用されています。 false: 偽の ASN は使用されていません。
AuthKey	String	BGP グループの認証キー。	なし。
Name	String	BGP ピアの名前。	なし。
AdvertisedRouteCount	String	アドバタイズされたルートの数。	なし。
ReceivedRouteCount	String	受信したルートの数。	なし。
GmtModified	String	BGP ピアが変更された時刻。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BgpPeerId:
    Type: String
    Description:
      en: The ID of the BGP peer that you want to query.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::BgpPeers
    Properties:
      BgpPeerId:
        Ref: BgpPeerId
Outputs:
  BgpPeerIds:
    Description: The list of The BGP peer ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BgpPeerIds
  BgpPeers:
    Description: The list of The BGP peers.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BgpPeers

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BgpPeerId": {
      "Type": "String",
      "Description": {
        "en": "クエリする BGP ピアの ID。"
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::BgpPeers",
      "Properties": {
        "BgpPeerId": {
          "Ref": "BgpPeerId"
        }
      }
    }
  },
  "Outputs": {
    "BgpPeerIds": {
      "Description": "BGP ピア ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BgpPeerIds"
        ]
      }
    },
    "BgpPeers": {
      "Description": "BGP ピアのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BgpPeers"
        ]
      }
    }
  }
}