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,
"BasePath": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
GroupName | String | Yes | Yes | The name of the API group. | The name must be unique. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (_). The name 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. |
InstanceId | String | No | No | The network type of the API Gateway instance. | Valid values:
|
InternetEnable | Boolean | No | Yes | Specifies whether to enable public subdomains. | Valid values:
|
VpcIntranetEnable | Boolean | No | Yes | Specifies whether to enable private subdomains. | Valid values:
|
PassthroughHeaders | String | No | No | The pass-through header. | Set the value to host. |
Tags | List | No | Yes | The tags of the API group. | You can specify up to 20 tags. For more information, see Tags properties. |
BasePath | String | No | Yes | The root path of the API. | Example: |
Tags syntax
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
Key | String | Yes | No | The key of the tag. | The tag key must be 1 to 128 characters in length, and cannot contain |
Value | String | No | No | The value of the tag. | The tag value can be up to 128 characters in length, and cannot contain |
Return values
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 GUID generated by the system.
Tags: the tags of the API group.