Use ALIYUN::ApiGateway::SignatureBinding to bind a backend signature to APIs - Resource Orchestration Service

ALIYUN::ApiGateway::SignatureBinding is used to bind a backend signature to APIs.

Syntax

{
  "Type": "ALIYUN::ApiGateway::SignatureBinding",
  "Properties": {
    "ApiIds": List,
    "GroupId": String,
    "StageName": String,
    "SignatureId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ApiIds	List	Yes	Yes	The IDs of the APIs to which you want to bind backend signatures.	You can specify up to 100 IDs.
GroupId	String	Yes	Yes	The ID of the API group to which the API belongs.	None.
SignatureId	String	Yes	Yes	The ID of the signature that you want to bind to APIs.	None.
StageName	String	Yes	Yes	The environment in which you want to bind the backend signature to APIs.	Valid values: TEST PRE RELEASE

Return values

Fn::GetAtt

None.

Examples

Note

Change the values of masked parameters, such as SignatureName, SignatureKey, and SignatureSecret, based on your business requirements.

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ApiIds:
    Type: String
    Description: API ID
  GroupId:
    Type: String
    Description: Group ID
Resources:
  Signature:
    Type: ALIYUN::ApiGateway::Signature
    Properties:
      SignatureName: ros_tes****
      SignatureKey: demo_test****
      SignatureSecret: demo_test_se****
  SignatureBinding:
    Type: ALIYUN::ApiGateway::SignatureBinding
    Properties:
      GroupId:
        Ref: GroupId
      SignatureId:
        Ref: Signature
      ApiIds:
        - Ref: ApiIds
      StageName: PRE

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ApiIds": {
      "Type": "String",
      "Description": "API ID"
    },
    "GroupId": {
      "Type": "String",
      "Description": "Group ID"
    }
  },
  "Resources": {
    "Signature": {
      "Type": "ALIYUN::ApiGateway::Signature",
      "Properties": {
        "SignatureName": "ros_tes****",
        "SignatureKey": "demo_test****",
        "SignatureSecret": "demo_test_se****"
      }
    },
    "SignatureBinding": {
      "Type": "ALIYUN::ApiGateway::SignatureBinding",
      "Properties": {
        "GroupId": {
         "Ref": "GroupId"
        },
        "SignatureId": {
          "Ref": "Signature"
        },
        "ApiIds": [{
          "Ref": "ApiIds"
        }],
        "StageName": "PRE"
      }
    }
  }
}