All Products
Search

This Product

    Resource Orchestration Service:ALIYUN::CEN::TransitRouterPeerAttachment

    Document Center

    Resource Orchestration Service:ALIYUN::CEN::TransitRouterPeerAttachment

    Last Updated:Apr 27, 2025

    ALIYUN::CEN::TransitRouterPeerAttachment is used to create a cross-region connection for an Enterprise Edition transit router.

    Syntax

    {
  "Type": "ALIYUN::CEN::TransitRouterPeerAttachment",
  "Properties": {
    "AutoPublishRouteEnabled": Boolean,
    "Bandwidth": Integer,
    "CenId": String,
    "TransitRouterAttachmentName": String,
    "PeerTransitRouterId": String,
    "CenBandwidthPackageId": String,
    "TransitRouterAttachmentDescription": String,
    "TransitRouterId": String,
    "PeerTransitRouterRegionId": String,
    "DefaultLinkType": String,
    "BandwidthType": String,
    "Tags": List
  }
}

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    PeerTransitRouterId

    String

    Yes

    No

    The ID of the peer transit router.

    None.

    AutoPublishRouteEnabled

    Boolean

    No

    Yes

    Specifies whether the Enterprise Edition transit router automatically advertises routes of the cross-region connection to the peer transit router.

    Valid values:

    • false (default)

    • true

    Bandwidth

    Integer

    No

    Yes

    The bandwidth that you want to allocate to the cross-region connection.

    Unit: Mbit/s.

    CenBandwidthPackageId

    String

    No

    Yes

    The ID of the bandwidth plan that you want to bind to the cross-region connection.

    If you do not specify a bandwidth plan ID, the default test bandwidth (1 Kbit/s) is used to test network connectivity.

    CenId

    String

    No

    No

    The ID of the Cloud Enterprise Network (CEN) instance.

    None.

    PeerTransitRouterRegionId

    String

    No

    No

    The region ID of the peer transit router.

    None.

    TransitRouterAttachmentDescription

    String

    No

    Yes

    The description of the cross-region connection.

    The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://.

    TransitRouterAttachmentName

    String

    No

    Yes

    The name of the cross-region connection.

    The name must be 2 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.

    TransitRouterId

    String

    No

    No

    The ID of the Enterprise Edition transit router.

    None.

    DefaultLinkType

    String

    No

    No

    The default line type.

    Valid values:

    • Gold (default)

    • Platinum

    BandwidthType

    String

    No

    No

    The bandwidth allocation method.

    Valid values:

    • BandwidthPackage: allocates the bandwidth from a bandwidth plan to the cross-region connection.

    • DataTransfer: does not allocate bandwidth to the cross-region connection but uses the pay-by-data-transfer metering method.

    Tags

    List

    No

    No

    The custom tags.

    For more information, see the "Tags properties" section of this topic.

    Tags syntax

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

    Tags properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    Key

    String

    Yes

    No

    The key of the tag.

    The key must be 1 to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http://or https://.

    Value

    String

    No

    No

    The value of the tag.

    The value can be up to 128 characters in length and cannot start with aliyunor acs:. It cannot contain http://or https://.

    Return values

    Fn::GetAtt

    • TransitRouterAttachmentId: the ID of the cross-region connection.

    Examples

    YAML format

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AutoPublishRouteEnabled:
    AllowedValues:
    - 'True'
    - 'true'
    - 'False'
    - 'false'
    Description: AutoPublishRouteEnabled
    Type: Boolean
  Bandwidth:
    Description: Bandwidth
    Type: Number
  CenBandwidthPackageId:
    Description: BandwidthPackageId
    Type: String
  CenId:
    Description: CenId
    Type: String
  PeerTransitRouterId:
    Description: PeerTransitRouterId
    Type: String
  PeerTransitRouterRegionId:
    Description: PeerTransitRouterRegionId
    Type: String
  TransitRouterAttachmentDescription:
    Description: TransitRouterAttachmentDescription
    Type: String
  TransitRouterAttachmentName:
    Description: TransitRouterAttachmentName
    Type: String
  TransitRouterId:
    Description: TransitRouterId
    Type: String
Resources:
  CENTransitRouterPeerAttachment:
    Properties:
      AutoPublishRouteEnabled:
        Ref: AutoPublishRouteEnabled
      Bandwidth:
        Ref: Bandwidth
      CenBandwidthPackageId:
        Ref: CenBandwidthPackageId
      CenId:
        Ref: CenId
      PeerTransitRouterId:
        Ref: PeerTransitRouterId
      PeerTransitRouterRegionId:
        Ref: PeerTransitRouterRegionId
      TransitRouterAttachmentDescription:
        Ref: TransitRouterAttachmentDescription
      TransitRouterAttachmentName:
        Ref: TransitRouterAttachmentName
      TransitRouterId:
        Ref: TransitRouterId
    Type: ALIYUN::CEN::TransitRouterPeerAttachment
Outputs:
  TransitRouterAttachmentId:
    Description: The first ID of the resource
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - TransitRouterAttachmentId

    JSON format

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AutoPublishRouteEnabled": {
      "Type": "Boolean",
      "Description": "AutoPublishRouteEnabled",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Bandwidth": {
      "Type": "Number",
      "Description": "Bandwidth"
    },
    "CenId": {
      "Type": "String",
      "Description": "CenId"
    },
    "TransitRouterAttachmentName": {
      "Type": "String",
      "Description": "TransitRouterAttachmentName"
    },
    "PeerTransitRouterId": {
      "Type": "String",
      "Description": "PeerTransitRouterId"
    },
    "CenBandwidthPackageId": {
      "Type": "String",
      "Description": "BandwidthPackageId"
    },
    "TransitRouterAttachmentDescription": {
      "Type": "String",
      "Description": "TransitRouterAttachmentDescription"
    },
    "TransitRouterId": {
      "Type": "String",
      "Description": "TransitRouterId"
    },
    "PeerTransitRouterRegionId": {
      "Type": "String",
      "Description": "PeerTransitRouterRegionId"
    }
  },
  "Resources": {
    "CENTransitRouterPeerAttachment": {
      "Type": "ALIYUN::CEN::TransitRouterPeerAttachment",
      "Properties": {
        "AutoPublishRouteEnabled": {
          "Ref": "AutoPublishRouteEnabled"
        },
        "Bandwidth": {
          "Ref": "Bandwidth"
        },
        "CenId": {
          "Ref": "CenId"
        },
        "TransitRouterAttachmentName": {
          "Ref": "TransitRouterAttachmentName"
        },
        "PeerTransitRouterId": {
          "Ref": "PeerTransitRouterId"
        },
        "CenBandwidthPackageId": {
          "Ref": "CenBandwidthPackageId"
        },
        "TransitRouterAttachmentDescription": {
          "Ref": "TransitRouterAttachmentDescription"
        },
        "TransitRouterId": {
          "Ref": "TransitRouterId"
        },
        "PeerTransitRouterRegionId": {
          "Ref": "PeerTransitRouterRegionId"
        }
      }
    }
  },
  "Outputs": {
    "TransitRouterAttachmentId": {
      "Description": "The first ID of the resource",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "TransitRouterAttachmentId"
        ]
      }
    }
   }
}