ALIYUN::Aligreen::Callback - Resource Orchestration Service

ALIYUN::Aligreen::Callback is used to create a callback.

Syntax

{
  "Type": "ALIYUN::Aligreen::Callback",
  "Properties": {
    "CallbackUrl": String,
    "CallbackName": String,
    "CallbackTypes": List,
    "CallbackSuggestions": List,
    "CryptType": Integer
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
CallbackUrl	String	Yes	Yes	The callback address of the moderation results.	None.
CallbackName	String	Yes	Yes	The name of the callback.	None.
CallbackTypes	List	Yes	Yes	The callback types.	Valid values: machineScan: machine audit result notification. selfAudit: self-service audit notification. You can specify up to two types.
CallbackSuggestions	List	Yes	Yes	The types of the Alibaba Cloud manual audit results.	Valid values: block: violation. review: suspected violation. pass: compliance. You can specify up to three types.
CryptType	Integer	No	No	The encryption algorithm.	Valid values: 0: Hash-based Message Authentication Code (HMAC) SHA256 encryption algorithm. 1: ShangMi 3 (SM3) Chinese cryptographic algorithm.

Return values

Fn::GetAtt

CallbackUrl: the callback address of the moderation results.
CryptType: the encryption algorithm.
CallbackId: the ID of the callback.
CallbackName: the name of the callback.
CallbackTypes: the callback types.
CallbackSuggestions: the types of the Alibaba Cloud manual audit results.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CallbackUrl:
    Type: String
    Description:
      en: The detection result will be called back to the url.
    Required: true
  CallbackName:
    Type: String
    Description:
      en: The Callback name defined by the customer. It can contain no more than 20 characters in Chinese, English, underscore (_), and digits.
    Required: true
  CallbackTypes:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: 'Represents the resource attribute field for the notification type. Value: self-service audit result (selfAudit) and machine audit result (machineScan).'
        AllowedValues:
          - selfAudit
          - machineScan
        Required: true
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: 'A list of Callback types. Value: machineScan: Machine audit result notification, selfAudit: self-service audit notification.'
    Required: true
    MinLength: 1
    MaxLength: 2
  CallbackSuggestions:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: 'Resource attribute fields that represent the results of the audit. Values: block, review and pass.'
        AllowedValues:
          - block
          - review
          - pass
        Required: true
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: 'List of audit results supported by message notification. Value: block: confirmed violation, review: Suspected violation, pass: normal.'
    Required: true
    MinLength: 1
    MaxLength: 3
Resources:
  ExtensionResource:
    Type: ALIYUN::Aligreen::Callback
    Properties:
      CallbackUrl:
        Ref: CallbackUrl
      CallbackName:
        Ref: CallbackName
      CallbackTypes:
        Ref: CallbackTypes
      CallbackSuggestions:
        Ref: CallbackSuggestions
Outputs:
  CallbackUrl:
    Description: The detection result will be called back to the url.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackUrl
  CryptType:
    Description: The encryption algorithm is used to verify that the callback request is sent by the Aliyun Green Service to your business service.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CryptType
  CallbackId:
    Description: The ID of the primary key of the Callback.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackId
  CallbackName:
    Description: The Callback name defined by the customer.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackName
  CallbackTypes:
    Description: The list of Callback types.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackTypes
  CallbackSuggestions:
    Description: List of audit results supported by message notification.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CallbackSuggestions

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CallbackUrl": {
      "Type": "String",
      "Description": {
        "en": "The detection result will be called back to the url."
      },
      "Required": true
    },
    "CallbackName": {
      "Type": "String",
      "Description": {
        "en": "The Callback name defined by the customer. It can contain no more than 20 characters in Chinese, English, underscore (_), and digits."
      },
      "Required": true
    },
    "CallbackTypes": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "Represents the resource attribute field for the notification type. Value: self-service audit result (selfAudit) and machine audit result (machineScan)."
          },
          "AllowedValues": [
            "selfAudit",
            "machineScan"
          ],
          "Required": true
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "A list of Callback types. Value: machineScan: Machine audit result notification, selfAudit: self-service audit notification."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 2
    },
    "CallbackSuggestions": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "Resource attribute fields that represent the results of the audit. Values: block, review and pass."
          },
          "AllowedValues": [
            "block",
            "review",
            "pass"
          ],
          "Required": true
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "List of audit results supported by message notification. Value: block: confirmed violation, review: Suspected violation, pass: normal."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 3
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::Aligreen::Callback",
      "Properties": {
        "CallbackUrl": {
          "Ref": "CallbackUrl"
        },
        "CallbackName": {
          "Ref": "CallbackName"
        },
        "CallbackTypes": {
          "Ref": "CallbackTypes"
        },
        "CallbackSuggestions": {
          "Ref": "CallbackSuggestions"
        }
      }
    }
  },
  "Outputs": {
    "CallbackUrl": {
      "Description": "The detection result will be called back to the url.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackUrl"
        ]
      }
    },
    "CryptType": {
      "Description": "The encryption algorithm is used to verify that the callback request is sent by the Aliyun Green Service to your business service.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CryptType"
        ]
      }
    },
    "CallbackId": {
      "Description": "The ID of the primary key of the Callback.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackId"
        ]
      }
    },
    "CallbackName": {
      "Description": "The Callback name defined by the customer.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackName"
        ]
      }
    },
    "CallbackTypes": {
      "Description": "The list of Callback types.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackTypes"
        ]
      }
    },
    "CallbackSuggestions": {
      "Description": "List of audit results supported by message notification.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CallbackSuggestions"
        ]
      }
    }
  }
}