DocsICP FilingConsole
Documentation
Home Page Resource Orchestration Service Developer Reference Resource Types CEN DATASOURCE::CEN::CenRouteMaps

DATASOURCE::CEN::CenRouteMaps

Updated at:
Copy as MD
Product
My Favorites

Queries routing policy information for a Cloud Enterprise Network (CEN) instance.

Syntax

{
  "Type": "DATASOURCE::CEN::CenRouteMaps",
  "Properties": {
    "TransitRouterRouteTableId": String,
    "TransmitDirection": String,
    "CenId": String,
    "CenRegionId": String,
    "RouteMapId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

TransitRouterRouteTableId

String

No

Yes

The route table ID of the transit router associated with the routing policy.

None.

TransmitDirection

String

No

Yes

The direction in which the routing policy is applied.

Valid values:

  • RegionIn: Routes are advertised to CEN regional gateways.

  • RegionOut: Routes are advertised from CEN regional gateways.

CenId

String

Yes

Yes

The CEN instance ID.

None.

CenRegionId

String

No

Yes

The region ID of the routing policy.

You can call the DescribeChildInstanceRegions operation to query the region ID.

RouteMapId

String

No

Yes

The routing policy ID.

None.

RefreshOptions

String

No

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

  • Never (default): Does not refresh data source resources when the stack is updated.

  • Always: Refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

  • RouteMapIds: the routing policy IDs.

  • RouteMaps: details of the routing policies.

Property

Type

Description

Constraint

RouteMapIds

List

The routing policy IDs.

None.

RouteMaps

List

Details of the routing policies.

None.

Status

String

The routing policy status.

Valid values:

  • Creating: The routing policy is being created.

  • Active: The routing policy is available.

  • Deleting: The routing policy is being deleted.

RouteMapId

String

The routing policy ID.

None.

TransmitDirection

String

The direction in which the routing policy is applied.

None.

SourceInstanceIdsReverseMatch

Boolean

Indicates whether source instance IDs are excluded.

Valid values:

  • true

  • false

CenRegionId

String

The region ID of the routing policy.

None.

CenId

String

The CEN instance ID.

None.

Priority

Number

The routing policy priority.

A smaller value indicates a higher priority.

TransitRouterRouteTableId

String

The route table ID of the transit router associated with the routing policy.

None.

CommunityOperateMode

String

The action performed on the community.

Valid values:

  • Additive: The community is added to the route.

  • Replace: The community replaces the original community of the route.

MapResult

String

The action performed on a route that meets all match conditions.

Valid values:

  • Permit: The route is permitted.

  • Deny: The route is denied.

CommunityMatchMode

String

The mode in which routes are matched based on communities.

Valid values:

  • Include: fuzzy match. A route is matched if its community overlaps with the community specified in the match condition.

  • Complete: exact match. A route is matched only if its community is the same as the community specified in the match condition.

Description

String

The routing policy description.

None.

AsPathMatchMode

String

The mode in which routes are matched based on autonomous system (AS) paths.

None.

Preference

Integer

The priority of the modified route.

A smaller value indicates a higher priority.

DestinationInstanceIdsReverseMatch

Boolean

Indicates whether destination instance IDs are excluded.

Valid values:

  • true: Destination instance IDs are excluded. A route is matched if its destination instance ID is not in the list specified by DestinationInstanceIds.

  • false: Destination instance IDs are included. A route is matched if its destination instance ID is in the list specified by DestinationInstanceIds.

CidrMatchMode

String

The mode in which routes are matched based on prefixes.

Valid values:

  • Include: fuzzy match

  • Complete: exact match

NextPriority

Integer

The priority of the next routing policy associated with the current routing policy.

None.

SourceRegionIds

List

The source region IDs used to match routes.

None.

SourceChildInstanceTypes

List

The source instance types used to match routes.

None.

DestinationRouteTableIds

List

The destination route table IDs used to match routes.

None.

SourceInstanceIds

List

The source instance IDs used to match routes.

None.

DestinationCidrBlocks

List

The route prefixes used to match routes.

None.

SourceRouteTableIds

List

The source route table IDs used to match routes.

None.

MatchCommunitySet

List

The communities used to match routes.

None.

PrependAsPath

List

The AS paths prepended when regional gateways receive or advertise routes.

None.

RouteTypes

List

The route types used to match routes.

None.

DestinationChildInstanceTypes

List

The destination instance types used to match routes.

None.

DestinationInstanceIds

List

The destination instance IDs used to match routes.

None.

MatchAsns

List

The AS paths used to match routes.

None.

OperateCommunitySet

List

The communities on which actions are performed.

None.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CenId": {
      "Type": "String",
      "Description": "The ID of the CEN instance."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::CEN::CenRouteMaps",
      "Properties": {
        "CenId": {
          "Ref": "CenId"
        }
      }
    }
  },
  "Outputs": {
    "RouteMapIds": {
      "Description": "The list of The RouteMap ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteMapIds"
        ]
      }
    },
    "RouteMaps": {
      "Description": "The information about RouteMaps.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteMaps"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CenId:
    Type: String
    Description: The ID of the CEN instance.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::CEN::CenRouteMaps
    Properties:
      CenId:
        Ref: CenId
Outputs:
  RouteMapIds:
    Description: The list of The RouteMap ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RouteMapIds
  RouteMaps:
    Description: The information about RouteMaps.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RouteMaps
Previous：DATASOURCE::CEN::CenInstancesNext：ClickHouse