All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::EDAS::UserDefineRegion

Last Updated:Apr 18, 2023

ALIYUN::EDAS::UserDefineRegion is used to create or edit a custom namespace.

Syntax

{
  "Type": "ALIYUN::EDAS::UserDefineRegion",
  "Properties": {
    "RegionName": String,
    "DebugEnable": Boolean,
    "Description": String,
    "RegionTag": String
  }
}

Properties

Parameter

Data type

Required

Editable

Description

Constraint

RegionName

String

Yes

Yes

Logical region (namespace)

N/A

DebugEnable

Boolean

No

Yes

Indicates whether remote debugging is allowed in this region.

Valid values:

  • true

  • false

Description

String

No

Yes

Logical region (namespace) description

The description must be 1 to 64 characters in length.

RegionTag

String

Yes

No

Logical region (namespace) ID

After a resource is created, the resource group ID in the format of "physical region ID: logical region identifier" cannot be changed.

The name of the logical region identifier must be 1 to 32 characters in length and can contain letters and digits.

Error code

Fn::GetAtt

  • BelongRegion: The ID of the physical region.

  • DebugEnable: Allows remote debugging.

  • UserId: The tenant account of the user.

  • Id: The ID of the logical region.

  • RegionName: The name of the logical region (namespace).

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionName:
    Type: String
    Description: Logical region (or namespace) name
    Default: mytest
Resources:
  UserDefineRegion:
    Type: ALIYUN::EDAS::UserDefineRegion
    Properties:
      RegionName:
        Ref: RegionName
      RegionTag:
        Fn::Join:
          - ':'
          - - Ref: ALIYUN::Region
            - Ref: RegionName
Outputs:
  BelongRegion:
    Description: Under the physical region ID
    Value:
      Fn::GetAtt:
        - UserDefineRegion
        - BelongRegion
  DebugEnable:
    Description: Whether debug is enable
    Value:
      Fn::GetAtt:
        - UserDefineRegion
        - DebugEnable
  UserId:
    Description: User account ID
    Value:
      Fn::GetAtt:
        - UserDefineRegion
        - UserId
  Id:
    Description: Resource ID
    Value:
      Fn::GetAtt:
        - UserDefineRegion
        - Id
  RegionName:
    Description: Region name
    Value:
      Fn::GetAtt:
        - UserDefineRegion
        - RegionName

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionName": {
      "Type": "String",
      "Description": "Logical region (or namespace) name",
      "Default": "mytest"
    }
  },
  "Resources": {
    "UserDefineRegion": {
      "Type": "ALIYUN::EDAS::UserDefineRegion",
      "Properties": {
        "RegionName": {
          "Ref": "RegionName"
        },
        "RegionTag": {
          "Fn::Join": [
            ":",
            [
              {
                "Ref": "ALIYUN::Region"
              },
              {
                "Ref": "RegionName"
              }
            ]
          ]
        }
      }
    }
  },
  "Outputs": {
    "BelongRegion": {
      "Description": "Under the physical region ID",
      "Value": {
        "Fn::GetAtt": [
          "UserDefineRegion",
          "BelongRegion"
        ]
      }
    },
    "DebugEnable": {
      "Description": "Whether debug is enable",
      "Value": {
        "Fn::GetAtt": [
          "UserDefineRegion",
          "DebugEnable"
        ]
      }
    },
    "UserId": {
      "Description": "User account ID",
      "Value": {
        "Fn::GetAtt": [
          "UserDefineRegion",
          "UserId"
        ]
      }
    },
    "Id": {
      "Description": "Resource ID",
      "Value": {
        "Fn::GetAtt": [
          "UserDefineRegion",
          "Id"
        ]
      }
    },
    "RegionName": {
      "Description": "Region name",
      "Value": {
        "Fn::GetAtt": [
          "UserDefineRegion",
          "RegionName"
        ]
      }
    }
  }
}