ALIYUN::ApiGateway::App is used to create an application. You must create an application before calling a third-party API because the application is used as an identity to call the API.

Syntax

{
  "Type" : "ALIYUN::ApiGateway::App",
  "Properties" : {
    "Description" : String,
    "AppName" : String
  }
}

Properties

Name Type Required Editable Description
AppName String Yes Yes The name of the application, which 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.
Description String No Yes The description of the application. The description can be up to 180 characters in length.

Response parameters

Fn::GetAtt

  • AppKey: the key of the application.
  • AppSecret: the secret of the application.
  • AppId: the ID of the application.

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "APP": {
      "Type": "ALIYUN::ApiGateway::App",
      "Properties": {
        "AppName": "my_test_app",
        "Description": "demo"
      }
    }
  }
}