DATASOURCE::CEN::TransitRouterPeerAttachments - Resource Orchestration Service

The DATASOURCE::CEN::TransitRouterPeerAttachments data source is used to query the details of inter-region connections of an Enterprise Edition transit router.

Syntax

{
  "Type": "DATASOURCE::CEN::TransitRouterPeerAttachments",
  "Properties": {
    "CenId": String,
    "RegionId": String,
    "RefreshOptions": String,
    "TransitRouterAttachmentId": String,
    "Tag": List,
    "TransitRouterId": String
  }
}

Properties

Property	Type	Required	Update Allowed	Description	Constraints
CenId	String	No	Yes	The ID of the CEN instance.	None
RegionId	String	No	Yes	The ID of the region where the Enterprise Edition transit router is deployed.	None
RefreshOptions	String	No	Yes	The refresh policy for the data source resource when the stack is updated.	Valid values: Never (default): The data source resource is never refreshed when the stack is updated. Always: The data source resource is always refreshed when the stack is updated.
TransitRouterAttachmentId	String	No	Yes	The ID of the inter-region connection.	None
Tag	List	No	Yes	The tags that are attached to the Enterprise Edition transit router.	For more information, see Tag properties.
TransitRouterId	String	No	Yes	The ID of the Enterprise Edition transit router.	None

Tag syntax

"Tag": [
  {
    "Value": String,
    "Key": String
  }
]

Tag properties

Property Name	Type	Required	Update Allowed	Description	Constraints
Key	String	Yes	No	The tag key.	None
Value	String	No	No	The tag value.	None

Return value

Fn::GetAtt

TransitRouterPeerAttachments: The details of the inter-region connections.
TransitRouterPeerAttachmentIds: A list of inter-region connection IDs.

Property Name	Type	Description	Constraints
TransitRouterPeerAttachmentIds	List	A list of inter-region connection IDs.	None
TransitRouterPeerAttachments	List	The details of the inter-region connections.	None
TransitRouterAttachmentId	String	The ID of the inter-region connection.	None
TransitRouterId	String	The ID of the Enterprise Edition transit router.	None
CenId	String	The ID of the CEN instance.	None
RegionId	String	The ID of the region where the Enterprise Edition transit router is deployed.	None
PeerTransitRouterId	String	The ID of the peer transit router.	None
PeerTransitRouterRegionId	String	The ID of the region where the peer transit router is deployed.	None
Status	String	The status of the inter-region connection.	Valid values: Attached: The resource is loaded. Attaching in progress. Detaching: Uninstalling a component. Detached: The connection is detached.
CreationTime	String	The time when the inter-region connection was created.	None
Bandwidth	String	The bandwidth of the inter-region connection.	Unit: Mbps.
BandwidthType	String	The method used to allocate bandwidth.	Valid values: BandwidthPackage: Bandwidth is allocated from a bandwidth plan. DataTransfer: No bandwidth is allocated to the inter-region connection. It is pay-by-traffic.
CenBandwidthPackageId	String	The ID of the bandwidth plan that is attached to the inter-region connection.	None
TransitRouterAttachmentName	String	The name of the inter-region connection.	None
TransitRouterAttachmentDescription	String	The description of the inter-region connection.	None
AutoPublishRouteEnabled	String	Indicates whether the Enterprise Edition transit router automatically advertises routes of the inter-region connection to the peer region.	None
GeographicSpanId	String	The connected areas of the bandwidth plan.	None
PeerTransitRouterOwnerId	String	The ID of the account to which the peer transit router belongs.	None
ResourceType	String	The type of resource that is associated with the connection.	Valid values: VPC: A virtual private cloud. CCN: a Cloud Connect Network instance. VBR: A virtual border router instance. TR: a transit router.
DefaultLinkType	String	The default link type.	Valid values: Gold (default): Gold. Platinum: Platinum.
Tags	List	A list of tags.	None

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CenId:
    Type: String
    Description:
      en: The ID of the CEN instance.
    Required: false
  RegionId:
    Type: String
    Description:
      en: The ID of the region where the transit router is deployed.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::CEN::TransitRouterPeerAttachments
    Properties:
      CenId:
        Ref: CenId
      RegionId:
        Ref: RegionId
Outputs:
  TransitRouterPeerAttachments:
    Description: The information about TransitRouterPeerAttachments.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TransitRouterPeerAttachments
  TransitRouterPeerAttachmentIds:
    Description: The list of The TransitRouterPeerAttachment IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TransitRouterPeerAttachmentIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CenId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the CEN instance."
      },
      "Required": false
    },
    "RegionId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the region where the transit router is deployed."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::CEN::TransitRouterPeerAttachments",
      "Properties": {
        "CenId": {
          "Ref": "CenId"
        },
        "RegionId": {
          "Ref": "RegionId"
        }
      }
    }
  },
  "Outputs": {
    "TransitRouterPeerAttachments": {
      "Description": "The information about TransitRouterPeerAttachments.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TransitRouterPeerAttachments"
        ]
      }
    },
    "TransitRouterPeerAttachmentIds": {
      "Description": "The list of The TransitRouterPeerAttachment IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TransitRouterPeerAttachmentIds"
        ]
      }
    }
  }
}