All Products
Search

This Product

    Resource Orchestration Service:ALIYUN::CEN::TransitRouterPeerAttachment

    Document Center

    Resource Orchestration Service:ALIYUN::CEN::TransitRouterPeerAttachment

    Last Updated:Aug 12, 2024

    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
  }
}

    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

    Return values

    Fn::GetAtt

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

    • GeographicSpanId: the areas that are covered by the bandwidth plan

    • PeerTransitRouterOwnerId: the ID of the Alibaba Cloud account to which the peer transit router belongs.

    • TransitRouterAttachmentName: the name of the cross-region connection.

    • ResourceType: the type of the resource.

    • AutoPublishRouteEnabled: indicates whether the Enterprise Edition transit router automatically advertises routes of the cross-region connection to the peer region.

    • Bandwidth: the bandwidth that is allocated to the cross-region connection.

    • CenId: the ID of the CEN instance.

    • PeerTransitRouterId: the ID of the peer transit router.

    • ClientToken: the client token that is used to ensure the idempotence of the request.

    • CenBandwidthPackageId: the ID of the bandwidth plan that is bound to the cross-region connection.

    • TransitRouterAttachmentDescription: the description of the cross-region connection.

    • TransitRouterId: the ID of the Enterprise Edition transit router.

    • PeerTransitRouterRegionId: the region ID of the peer transit router.

    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:
  AutoPublishRouteEnabled:
    Description: AutoPublishRouteEnabled
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - AutoPublishRouteEnabled
  Bandwidth:
    Description: Bandwidth
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - Bandwidth
  CenBandwidthPackageId:
    Description: BandwidthPackageId
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - CenBandwidthPackageId
  CenId:
    Description: CenId
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - CenId
  ClientToken:
    Description: ClientToken
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - ClientToken
  GeographicSpanId:
    Description: GeographicSpanId
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - GeographicSpanId
  PeerTransitRouterId:
    Description: PeerTransitRouterId
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - PeerTransitRouterId
  PeerTransitRouterOwnerId:
    Description: PeerTransitRouterOwnerId
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - PeerTransitRouterOwnerId
  PeerTransitRouterRegionId:
    Description: PeerTransitRouterRegionId
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - PeerTransitRouterRegionId
  ResourceType:
    Description: ResourceType
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - ResourceType
  TransitRouterAttachmentDescription:
    Description: TransitRouterAttachmentDescription
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - TransitRouterAttachmentDescription
  TransitRouterAttachmentId:
    Description: The first ID of the resource
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - TransitRouterAttachmentId
  TransitRouterAttachmentName:
    Description: TransitRouterAttachmentName
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - TransitRouterAttachmentName
  TransitRouterId:
    Description: TransitRouterId
    Value:
      Fn::GetAtt:
      - CENTransitRouterPeerAttachment
      - TransitRouterId

    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"
        ]
      }
    },
    "GeographicSpanId": {
      "Description": "GeographicSpanId",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "GeographicSpanId"
        ]
      }
    },
    "PeerTransitRouterOwnerId": {
      "Description": "PeerTransitRouterOwnerId",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "PeerTransitRouterOwnerId"
        ]
      }
    },
    "TransitRouterAttachmentName": {
      "Description": "TransitRouterAttachmentName",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "TransitRouterAttachmentName"
        ]
      }
    },
    "ResourceType": {
      "Description": "ResourceType",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "ResourceType"
        ]
      }
    },
    "AutoPublishRouteEnabled": {
      "Description": "AutoPublishRouteEnabled",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "AutoPublishRouteEnabled"
        ]
      }
    },
    "Bandwidth": {
      "Description": "Bandwidth",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "Bandwidth"
        ]
      }
    },
    "CenId": {
      "Description": "CenId",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "CenId"
        ]
      }
    },
    "PeerTransitRouterId": {
      "Description": "PeerTransitRouterId",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "PeerTransitRouterId"
        ]
      }
    },
    "ClientToken": {
      "Description": "ClientToken",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "ClientToken"
        ]
      }
    },
    "CenBandwidthPackageId": {
      "Description": "BandwidthPackageId",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "CenBandwidthPackageId"
        ]
      }
    },
    "TransitRouterAttachmentDescription": {
      "Description": "TransitRouterAttachmentDescription",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "TransitRouterAttachmentDescription"
        ]
      }
    },
    "TransitRouterId": {
      "Description": "TransitRouterId",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "TransitRouterId"
        ]
      }
    },
    "PeerTransitRouterRegionId": {
      "Description": "PeerTransitRouterRegionId",
      "Value": {
        "Fn::GetAtt": [
          "CENTransitRouterPeerAttachment",
          "PeerTransitRouterRegionId"
        ]
      }
    }
  }
}