DATASOURCE::VPC::BgpPeer is used to query the information about a Border Gateway Protocol (BGP) peer in a region.
Syntax
{
"Type": "DATASOURCE::VPC::BgpPeer",
"Properties": {
"BgpPeerId": String,
"RefreshOptions": String
}
}Properties
Property | Type | Required | Editable | Description | Constraint |
BgpPeerId | String | No | Yes | The ID of the BGP peer. | None. |
RefreshOptions | String | No | Yes | The refresh policy for data source resources when the stack is updated. | Valid values:
|
Return values
Fn::GetAtt
Status: the status of the BGP peer.
Description: the description of the BGP group.
PeerIpAddress: the IP address of the BGP peer.
IpVersion: the IP version.
Keepalive: the keepalive period.
GmtModified: the time when the BGP peer was modified.
RouterId: the ID of the router.
ReceivedRouteCount: the number of received routes.
PeerAsn: the autonomous system number (ASN) of the BGP peer.
Name: the name of the BGP peer.
BgpPeerId: the ID of the BGP peer.
LocalAsn: the ASN of the device on the Alibaba Cloud side.
AdvertisedRouteCount: the number of advertised routes.
EnableBfd: indicates whether Bidirectional Forwarding Detection (BFD) is enabled.
BfdMultiHop: the number of BFD hops.
BgpStatus: the status of the BGP connection.
IsFake: indicates whether a fake ASN is used.
AuthKey: the authentication key of the BGP group.
RouteLimit: the limit on routes.
Hold: the hold time.
BgpGroupId: the ID of the BGP group.
Examples
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
{
"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:\n* Pending\n* Available\n* Modifying\n* Deleting\n* 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:\n* false\n* 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:\n* Idle: The BGP connection is not used.\n* Connect: The BGP connection is used.\n* Active: The BGP connection is available.\n* Established: The BGP connection is established.\n* 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:\n* false\n* 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"
]
}
}
}
}