ALIYUN::PAIPlugin::Template - Resource Orchestration Service

ALIYUN::PAIPlugin::Template is used to create a template.

Syntax

{
  "Type": "ALIYUN::PAIPlugin::Template",
  "Properties": {
    "Content": String,
    "Description": String,
    "Name": String,
    "Type": Integer,
    "SignatureId": String,
    "Signature": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Content	String	Yes	No	The content of the template.	None.
Description	String	Yes	No	The description of the template.	None.
Name	String	Yes	No	The name of the template.	None.
Type	Integer	Yes	No	The type of the template.	Valid values: 0: verification code 1: text message notification 2: promotional text message
SignatureId	String	No	No	The ID of the signature.	To use ALIYUN::PAIPlugin::Template, you must specify SignatureId or Signature.
Signature	String	No	No	The signature.	To use ALIYUN::PAIPlugin::Template, you must specify SignatureId or Signature.

Return values

Fn::GetAtt

CreatedTime: the creation time of the signature.
Description: the description of the template.
Id: the ID of the signature.
Reason: the review suggestion.
Name: the signature.

Examples

YAML

                              ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Content:
    Description:
      en: The content of the template.
    Required: true
    Type: String
  Description:
    AssociationProperty: TextArea
    Description:
      en: For the template content, please keep the total word count within 70 words.
        The excess will be charged as long text messages. Each text message is recorded
        as 67 words.
    Required: true
    Type: String
  Name:
    Description:
      en: The name of the template.
    Required: true
    Type: String
  Signature:
    Description:
      en: The name of the Signature, You must select either Signature or SignatureId,
        but not both.
    Required: false
    Type: String
  SignatureId:
    Description:
      en: The ID of the Signature, You must select either Signature or SignatureId,
        but not both.
    Required: false
    Type: String
  Type:
    AllowedValues:
    - 0
    - 1
    - 2
    Description:
      en: 'The type of the template. The following values are supported:

        0: Verification code.

        1: SMS notification.

        2: Promotional SMS.'
    Required: true
    Type: Number
Resources:
  ExtensionResource:
    Properties:
      Content:
        Ref: Content
      Description:
        Ref: Description
      Name:
        Ref: Name
      Signature:
        Ref: Signature
      SignatureId:
        Ref: SignatureId
      Type:
        Ref: Type
    Type: ALIYUN::PAIPlugin::Template
Outputs:
  CreatedTime:
    Description: The creation time of the Signature.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - CreatedTime
  Description:
    Description: Application instructions.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Description
  Id:
    Description: The ID of the Signature.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Id
  Name:
    Description: The name of the Signature.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Name
  Reason:
    Description: Review recommendations.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Reason

JSON

                        {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SignatureId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the Signature, You must select either Signature or SignatureId, but not both."
      },
      "Required": false
    },
    "Type": {
      "Type": "Number",
      "Description": {
        "en": "The type of the template. The following values are supported:\n0: Verification code.\n1: SMS notification.\n2: Promotional SMS."
      },
      "AllowedValues": [
        0,
        1,
        2
      ],
      "Required": true
    },
    "Description": {
      "AssociationProperty": "TextArea",
      "Type": "String",
      "Description": {
        "en": "For the template content, please keep the total word count within 70 words. The excess will be charged as long text messages. Each text message is recorded as 67 words."
      },
      "Required": true
    },
    "Content": {
      "Type": "String",
      "Description": {
        "en": "The content of the template."
      },
      "Required": true
    },
    "Signature": {
      "Type": "String",
      "Description": {
        "en": "The name of the Signature, You must select either Signature or SignatureId, but not both."
      },
      "Required": false
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "The name of the template."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::PAIPlugin::Template",
      "Properties": {
        "SignatureId": {
          "Ref": "SignatureId"
        },
        "Type": {
          "Ref": "Type"
        },
        "Description": {
          "Ref": "Description"
        },
        "Content": {
          "Ref": "Content"
        },
        "Signature": {
          "Ref": "Signature"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "CreatedTime": {
      "Description": "The creation time of the Signature.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreatedTime"
        ]
      }
    },
    "Description": {
      "Description": "Application instructions.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "Id": {
      "Description": "The ID of the Signature.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Id"
        ]
      }
    },
    "Reason": {
      "Description": "Review recommendations.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Reason"
        ]
      }
    },
    "Name": {
      "Description": "The name of the Signature.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Name"
        ]
      }
    }
  }
}