All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::ApiGateway::Signature

Last Updated:Jul 10, 2024

ALIYUN::ApiGateway::Signature is used to create a backend signature.

Syntax

{
  "Type": "ALIYUN::ApiGateway::Signature",
  "Properties": {
    "SignatureSecret": String,
    "SignatureName": String,
    "SignatureKey": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

SignatureKey

String

Yes

Yes

The key of the signature.

The key must be 6 to 20 characters in length and can contain letters, digits, and underscores (_). The key must start with a letter.

SignatureName

String

Yes

No

The name of the signature.

The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). The name must start with a letter.

SignatureSecret

String

Yes

Yes

The secret value of the signature.

The secret value must be 6 to 30 characters in length and must start with a letter. The secret value can contain letters, digits, underscores (_), and the following special characters:

  • @

  • #

  • !

  • *

Return values

Fn::GetAtt

SignatureId: the ID of the backend signature.

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'
Resources:
  Signature:
    Type: ALIYUN::ApiGateway::Signature
    Properties:
      SignatureName: demo_****
      SignatureKey: demo_test****
      SignatureSecret: demo_test_se****

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Signature": {
      "Type": "ALIYUN::ApiGateway::Signature",
      "Properties": {
        "SignatureName": "demo_****",
        "SignatureKey": "demo_test****",
        "SignatureSecret": "demo_test_se****"
      }
    }
  }
}