All Products
Search

This Product

    Resource Orchestration Service:ALIYUN::ApiGateway::SignatureBinding

    Document Center

    Resource Orchestration Service:ALIYUN::ApiGateway::SignatureBinding

    Last Updated:Jun 10, 2026

    ALIYUN::ApiGateway::SignatureBinding binds 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 API IDs to bind backend signatures to.

    Maximum: 100.

    GroupId

    String

    Yes

    Yes

    The ID of the API group.

    None.

    SignatureId

    String

    Yes

    Yes

    The signature ID to bind to APIs.

    None.

    StageName

    String

    Yes

    Yes

    The environment to bind the signature in.

    Valid values:

    • TEST

    • PRE

    • RELEASE

    Return values

    Fn::GetAtt

    None.

    Examples

    Note

    Replace masked parameter values (SignatureName, SignatureKey, SignatureSecret) with your actual values.

    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"
      }
    }
  }
}