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

Syntax

{
  "Type": "ALIYUN::ApiGateway::Group",
  "Properties": {
    "GroupName": String,
    "Description": String,
    "InstanceId": String,
    "PassthroughHeaders": String,
    "InternetEnable": Boolean,
    "VpcIntranetEnable": Boolean,
    "Tags": List
  }
}   

Properties

Property Type Required Editable Description Constraint
GroupName String Yes Yes The name of the API group. The name must be unique.

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

Description String No Yes The description of the API group. The description can be up to 180 characters in length.
InstanceId String No No The network type of the API Gateway instance. Valid values:
  • api-shared-vpc-001: VPC.
  • api-shared-classic-001: classic network.
InternetEnable Boolean No Yes Specifies whether to enable the public subdomain. Valid values:
  • true
  • false
VpcIntranetEnable Boolean No Yes Specifies whether to enable the private subdomain. Valid values:
  • true
  • false
PassthroughHeaders String No No Configure the pass-through mode. Set the value to host.
Tags List No Yes The list of tags of the API group. You can specify up to 20 tags for an API group.

For more information, see Tags properties.

Tags syntax

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

Tags properties

Property Type Required Editable Description Constraint
Key String Yes No The key of a tag. The tag key must be 1 to 128 characters in length and cannot contain http:// or https://. It cannot start with acs: or aliyun.
Value String No No The value of a tag. The tag value can be up to 128 characters in length and cannot contain http:// or https://. It cannot start with acs: or aliyun.

Return value

Fn::GetAtt

  • SubDomain: the second-level domain that the system assigns to the API group. The domain is used to test API calls.
  • GroupId: the ID of the API group. The ID is a globally unique identifier (GUID) generated by the system.
  • Tags: tags of the API group.

Examples

  • YAMLformat

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      Group:
        Type: ALIYUN::ApiGateway::Group
        Properties:
          InternetEnable: false
          GroupName: TestGroup
          InstanceId: api-shared-vpc-001
          VpcIntranetEnable: false
          PassthroughHeaders: host
    Outputs: {}
  • JSONformat

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "Group": {
          "Type": "ALIYUN::ApiGateway::Group",
          "Properties": {
            "InternetEnable": false,
            "GroupName": "TestGroup",
            "InstanceId": "api-shared-vpc-001",
            "VpcIntranetEnable": false,
            "PassthroughHeaders": "host"
          }
        }
      },
      "Outputs": {
      }
    }