ALIYUN::ApiGateway::TrafficControlBinding is used to set custom throttling policies for APIs.

Syntax

{
  "Type": "ALIYUN::ApiGateway::TrafficControlBinding",
  "Properties": {
    "ApiIds": List,
    "TrafficControlId": String,
    "StageName": String,
    "GroupId": String
  }
}

Properties

Name Type Required Editable Description
ApiIds List Yes Yes The IDs of the APIs for which you want to configure throttling policies. A maximum of 100 API IDs can be entered.
TrafficControlId String Yes Yes The ID of the throttling policy.
StageName String Yes Yes The name of the runtime environment. Valid values: TEST, PRE, and RELEASE.
GroupId String Yes Yes The ID of the API group that contains the APIs for which you want to configure throttling policies.

Response parameters

Fn::GetAtt

None

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TrafficControlId": {
      "Type": "String",
      "Description": "The throttling policy ID"
    },
    "GroupId": {
      "Type": "String",
      "Description": "API group ID"
    },
    "ApiId": {
      "Type": "String",
      "Description": "API IDs"
    }
  },
  "Resources": {
    "TrafficControlBinding": {
      "Type": "ALIYUN::ApiGateway::TrafficControlBinding",
      "Properties": {
        "TrafficControlId": {
          "Ref": "TrafficControlId"
        },
        "GroupId": {
          "Ref": "GroupId"
        },
        "ApiIds": [
          {
            "Ref": "ApiId"
          }
        ],
        "StageName": "RELEASE"
      }
    }
  }
}