ALIYUN::ApiGateway::App is used to create an application. Before you call a third-party API, you must create an application and use the application as an identity to call the API.
Syntax
{
"Type": "ALIYUN::ApiGateway::App",
"Properties": {
"Description": String,
"Tags": List,
"AppName": String,
"AppSecret": String,
"AppCode": String,
"AppKey": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
AppName | String | Yes | Yes | The application name. | The name must be globally unique. We recommend that you add a special identifier to ensure that the name is unique. The name must be 4 to 15 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter. |
Tags | List | No | Yes | The tags of the application. | You can specify up to 20 tags. |
Description | String | No | Yes | The description of the application. | The description can be up to 180 characters in length. |
AppSecret | String | No | No | The password of the application. | None. |
AppCode | String | No | No | The AppCode of the application. | None. |
AppKey | String | No | No | The key of the application. | The key is used for calling an API. |
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
AppKey: the key of the application.
AppSecret: the secret of the application.
AppId: the application ID.
Tags: the tags of the application.
AppCode: the AppCode of the application.