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

Syntax

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

Properties

Property Type Required Editable Description Constraint
ApiIds List Yes Yes The ID of the specified API. A maximum of 100 API operation IDs can be entered.
AppIds List Yes Yes The IDs of the applications. An ID is a globally unique identifier (GUID) generated by the system. You can specify multiple application IDs.
GroupId String Yes Yes The ID of the API group to which the API belongs. The ID is a GUID generated by the system.
StageName String Yes Yes The name of the environment. Valid values:
  • TEST
  • PRE
  • RELEASE
Description String No Yes The description of the authorization. None.

Response parameters

Fn::GetAtt

None.

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Default": "xxxx10b1b4dc7a2e6ba8ca3xxxx",
      "Description": "The ID of the API group"
    },
    "AppId": {
      "Type": "Number",
      "Default": 577****,
      "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"
      }
    }
  }
}