DATASOURCE::VPC::BgpPeer 概要（ROS スタック統合）- ROS

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

構文

{
  "Type": "DATASOURCE::VPC::BgpPeer",
  "Properties": {
    "BgpPeerId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

BgpPeerId

String

いいえ

はい

BGP ピアの ID。

なし。

RefreshOptions

String

いいえ

はい

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

有効な値:

Never (デフォルト): スタックが更新されたときにデータソースリソースをリフレッシュしません。
Always: スタックが更新されたときにデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

Status: BGP ピアのステータス。
Description: BGP グループの説明。
PeerIpAddress: BGP ピアの IP アドレス。
IpVersion: IP バージョン。
Keepalive: キープアライブ期間。
GmtModified: BGP ピアが変更された時刻。
RouterId: ルーターの ID。
ReceivedRouteCount: 受信ルートの数。
PeerAsn: BGP ピアの自律システム番号 (ASN)。
Name: BGP ピアの名前。
BgpPeerId: BGP ピアの ID。
LocalAsn: Alibaba Cloud 側のデバイスの ASN。
AdvertisedRouteCount: アドバタイズされたルートの数。
EnableBfd: 双方向転送検出 (BFD) が有効になっているかどうかを示します。
BfdMultiHop: BFD ホップの数。
BgpStatus: BGP 接続のステータス。
IsFake: 偽の ASN が使用されているかどうかを示します。
AuthKey: BGP グループの認証キー。
RouteLimit: ルートの制限。
Hold: ホールド時間。
BgpGroupId: BGP グループの ID。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BgpPeerId:
    Type: String
    Description:
      en: The ID of the BGP peer.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::BgpPeer
    Properties:
      BgpPeerId:
        Ref: BgpPeerId
Outputs:
  Status:
    Description: |-
      The status of the BGP peer. Valid values:
      * Pending
      * Available
      * Modifying
      * Deleting
      * Deleted
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Status
  Description:
    Description: The description of the BGP group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  PeerIpAddress:
    Description: The IP address of the BGP peer.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PeerIpAddress
  IpVersion:
    Description: The version of the IP address.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IpVersion
  Keepalive:
    Description: The Keepalive interval.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Keepalive
  GmtModified:
    Description: The time when the BGP peer is modified.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GmtModified
  RouterId:
    Description: The Router ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RouterId
  ReceivedRouteCount:
    Description: The number of received routes.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReceivedRouteCount
  PeerAsn:
    Description: The autonomous system number (ASN)of the BGP peer.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PeerAsn
  Name:
    Description: The name of the BGP peer.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Name
  BgpPeerId:
    Description: The ID of the BGP peer.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BgpPeerId
  LocalAsn:
    Description: The ASN of the device on the Alibaba Cloud side.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LocalAsn
  AdvertisedRouteCount:
    Description: The number of advertised routes.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AdvertisedRouteCount
  EnableBfd:
    Description: |-
      Indicates whether BFD is enabled. Valid values:
      * false
      * true
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnableBfd
  BfdMultiHop:
    Description: The Bidirectional Forwarding Detection (BFD) hop count.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BfdMultiHop
  BgpStatus:
    Description: |-
      The status of the BGP connection. Valid values:
      * Idle: The BGP connection is not used.
      * Connect: The BGP connection is used.
      * Active: The BGP connection is available.
      * Established: The BGP connection is established.
      * Down: The BGP connection is unavailable.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BgpStatus
  IsFake:
    Description: |-
      Indicates whether a fake autonomous system number (ASN) is used. Valid values:
      * false
      * true
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IsFake
  AuthKey:
    Description: The authentication key of the BGP group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AuthKey
  RouteLimit:
    Description: The maximum number of routes.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RouteLimit
  Hold:
    Description: The hold time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Hold
  BgpGroupId:
    Description: The ID of the BGP group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BgpGroupId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BgpPeerId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the BGP peer."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::BgpPeer",
      "Properties": {
        "BgpPeerId": {
          "Ref": "BgpPeerId"
        }
      }
    }
  },
  "Outputs": {
    "Status": {
      "Description": "BGP ピアのステータス。有効な値:\n* Pending\n* Available\n* Modifying\n* Deleting\n* Deleted",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Status"
        ]
      }
    },
    "Description": {
      "Description": "BGP グループの説明。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "PeerIpAddress": {
      "Description": "BGP ピアの IP アドレス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PeerIpAddress"
        ]
      }
    },
    "IpVersion": {
      "Description": "IP アドレスのバージョン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IpVersion"
        ]
      }
    },
    "Keepalive": {
      "Description": "キープアライブ間隔。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Keepalive"
        ]
      }
    },
    "GmtModified": {
      "Description": "BGP ピアが変更された時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GmtModified"
        ]
      }
    },
    "RouterId": {
      "Description": "ルーター ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouterId"
        ]
      }
    },
    "ReceivedRouteCount": {
      "Description": "受信ルートの数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReceivedRouteCount"
        ]
      }
    },
    "PeerAsn": {
      "Description": "BGP ピアの自律システム番号 (ASN)。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PeerAsn"
        ]
      }
    },
    "Name": {
      "Description": "BGP ピアの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Name"
        ]
      }
    },
    "BgpPeerId": {
      "Description": "BGP ピアの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BgpPeerId"
        ]
      }
    },
    "LocalAsn": {
      "Description": "Alibaba Cloud 側のデバイスの ASN。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LocalAsn"
        ]
      }
    },
    "AdvertisedRouteCount": {
      "Description": "アドバタイズされたルートの数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AdvertisedRouteCount"
        ]
      }
    },
    "EnableBfd": {
      "Description": "BFD が有効になっているかどうかを示します。有効な値:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnableBfd"
        ]
      }
    },
    "BfdMultiHop": {
      "Description": "双方向転送検出 (BFD) ホップ数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BfdMultiHop"
        ]
      }
    },
    "BgpStatus": {
      "Description": "BGP 接続のステータス。有効な値:\n* Idle: BGP 接続は使用されていません。\n* Connect: BGP 接続は使用されています。\n* Active: BGP 接続は利用可能です。\n* Established: BGP 接続は確立されています。\n* Down: BGP 接続は利用できません。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BgpStatus"
        ]
      }
    },
    "IsFake": {
      "Description": "偽の自律システム番号 (ASN) が使用されているかどうかを示します。有効な値:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IsFake"
        ]
      }
    },
    "AuthKey": {
      "Description": "BGP グループの認証キー。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AuthKey"
        ]
      }
    },
    "RouteLimit": {
      "Description": "ルートの最大数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteLimit"
        ]
      }
    },
    "Hold": {
      "Description": "ホールド時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Hold"
        ]
      }
    },
    "BgpGroupId": {
      "Description": "BGP グループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BgpGroupId"
        ]
      }
    }
  }
}