すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::ApiGateway::SignatureBinding

最終更新日:Jan 16, 2025

ALIYUN::ApiGateway::SignatureBinding は、バックエンド署名を API にバインドするために使用されます。

構文

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

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ApiIds

List

はい

はい

バックエンド署名をバインドする API の ID。

最大 100 個の ID を指定できます。

GroupId

String

はい

はい

API が属する API グループの ID。

なし。

SignatureId

String

はい

はい

API にバインドする署名の ID。

なし。

StageName

String

はい

はい

バックエンド署名を API にバインドする環境。

有効な値:

  • TEST

  • PRE

  • RELEASE

戻り値

Fn::GetAtt

なし。

説明

SignatureName、SignatureKey、SignatureSecret などのマスクされたパラメーターの値は、ビジネス要件に基づいて変更してください。

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ApiIds:
    Type: String
    Description: API ID  # API ID
  GroupId:
    Type: String
    Description: Group ID # グループ 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 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ApiIds": {
      "Type": "String",
      "Description": "API ID" // API ID
    },
    "GroupId": {
      "Type": "String",
      "Description": "Group ID" // グループ 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"
      }
    }
  }
}