ALIYUN::ApiGateway::Authorization is used to authorize applications to call APIs.

Syntax

{
  "Type": "ALIYUN::ApiGateway::Authorization",
  "Properties": {
    "ApiIds": List,
    "AppIds": List,
    "GroupId": String,
    "StageName": String,
    "Description": String
  }
}

Properties

Name Type Required Editable Description
ApiIds List Yes Yes The IDs of APIs to allow to be called. A maximum of 100 API IDs can be entered.
AppIds List Yes Yes The unique system-generated IDs of applications. Multiple IDs can be entered.
GroupId String Yes Yes The unique system-generated ID of the API group.
StageName String Yes Yes The name of the environment. Valid values: TEST, PRE, and RELEASE.
Description String No Yes The authorization description.

Response parameters

Fn::GetAtt

None

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Default": "xxxx10b1b4dc7a2e6ba8ca3xxxx",
      "Description": "The API group ID"
    },
    "AppId": {
      "Type": "Number",
      "Default": 5778174,
      "Description": "APP ID"
    },
    "ApiId": {
      "Type": "String",
      "Default": "xxxxx2a8b6d4ce2ad1f95cbxxxxx",
      "Description": "API ID"
    }
  },
  "Resources": {
    "Authorization": {
      "Type": "ALIYUN::ApiGateway::Authorization",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        },
        "StageName": "TEST",
        "AppIds": [
          {
            "Ref": "AppId"
          }
        ],
        "ApiIds": [
          {
            "Ref": "ApiId"
          }
        ],
        "Description": "demo"
      }
    }
  }
}