ALIYUN::ApiGateway::Group is used to create an API group.

Syntax

{
  "Type": "ALIYUN::ApiGateway::Group",
  "Properties": {
    "GroupName": String,
    "Description": String
  }
}

Properties

Name Type Required Editable Description
GroupName String Yes Yes The name of the API group, which must be globally unique. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). It must start with a letter.
Description String No Yes The description of the API group. The description can be up to 180 characters in length.

Response parameters

Fn::GetAtt

  • SubDomain: the second-level domain name that the system binds to the group, which is used to test API calls.
  • GroupId: the ID of the API group. This ID is a globally unique identifier generated by the system.

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Create a group",
  "Resources": {
    "Group": { 
      "Type": "ALIYUN::ApiGateway::Group", 
      "Properties": { 
        "GroupName": "demo_group",
        "Description": "demo"
      }
    }
  },
  "Outputs": {
    "GroupId": {
      "Description": "Group ID",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "GroupId"
        ]
      }
    },
    "SubDomain": {
      "Description": "Sub Domain",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "SubDomain"
        ]
      }
    }
  }
}