This document describes the request types and request fields for developer templates.
Template developer request types
Template developers use the Alibaba Cloud ROS resource ALIYUN::ROS::CustomResource to specify custom resources in a template.
ALIYUN::ROS::CustomResource includes three properties: ServiceToken, Parameters, and Timeout.
Property Name | Type | Required | Description | Constraints |
ServiceToken | String | Yes | The service token. The custom service provider provides this token to the template developer. | Currently, support is provided for FC functions, SMQ (Simple Message Queue (formerly MNS)) topics, SMQ (Simple Message Queue (formerly MNS)) queues, and HTTP&HTTPS. The service token has no region restrictions. |
Parameters | Map | No | Parameters to pass to the custom service provider. Specify the parameters as required by the custom service provider. | None |
Timeout | Number | No | The timeout period for waiting for a response from the custom service provider. | Value range: 1 to 43200 Unit: seconds Default value: 60 |
Custom resource provider request fields
Alibaba Cloud ROS sends the following fields to the custom resource provider in a JSON request.
Field Name | Type | Required | Description | Constraints |
RequestType | String | Yes | The request type set by an Alibaba Cloud ROS stack operation (create, update, or delete a stack). The stack operation is initiated by the template developer for the stack that contains the custom resource. | Values:
For more information, see Custom resource request types. |
ResponseURL | String | Yes | A presigned public URL. This URL receives responses from the custom resource provider to Alibaba Cloud ROS. | None |
IntranetResponseURL | String | Yes | A presigned internal network URL. You can use this URL in an Alibaba Cloud ECS instance. This URL receives responses from the custom resource provider to Alibaba Cloud ROS. | None |
StackId | String | Yes | The ID of the stack that contains the custom resource. | None |
StackName | String | Yes | The name of the stack that contains the custom resource. | None |
ResourceOwnerId | String | Yes | The Alibaba Cloud account ID (root account) of the owner of the stack that contains the custom resource. | None |
CallerId | String | Yes | The ID of the account (root account or RAM user) that performs this stack operation. | None |
RegionId | String | Yes | The region of the stack that contains the custom resource. | None |
RequestId | String | Yes | The unique ID of the request. Combine StackId and RequestId to create a value that uniquely identifies a request for a specific custom resource. | None |
ResourceType | String | Yes | The resource type of the custom resource that the template developer selected in the Alibaba Cloud ROS template. | A maximum of 68 characters. It can contain letters, digits, underscores (_), at signs (@), and hyphens (-). |
LogicalResourceId | String | Yes | The name (logical ID) of the custom resource that the template developer selected in the Alibaba Cloud ROS template. This is used to facilitate communication between the custom resource provider and the template developer. | None |
PhysicalResourceId | String | Yes | The physical ID defined by the custom resource provider. This ID is unique to that provider. | Used only for Update and Delete requests. |
ResourceProperties | JSON object | Yes | The resource properties. This field contains the content of the Parameters object in the Properties sent by the template developer. The content is defined by the custom resource provider. | None |
OldResourceProperties | JSON object | No | The resource properties declared before the update request. | Used only for Update requests. |