CreateStack

The operation that you want to perform. Set the value to CreateStack.

Specifies whether to disable rollback of the stack when the stack fails to be created.

Default value: false. Valid values:

• true: disables rollback of the stack when the stack fails to be created.
• false: enables rollback of the stack when the stack fails to be created.

The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body exceeds the upper limit, we recommend that you add parameters to the HTTP POST request body to prevent request failures caused by excessively long URLs.

The URL of the file that contains the stack policy. The URL must point to a policy located in an HTTP or HTTPS web server or in an Alibaba Cloud OSS bucket, for example, oss://ros/stack-policy/demo and oss://ros/stack-policy/demo?RegionId=cn-hangzhou. The policy can be up to 16,384 bytes in length and the URL can be up to 1,350 bytes in length. If you do not specify RegionId in the URL, the region ID of the stack group is used.

The timeout period that is specified for the stack creation request.

• Default value: 60.
• Unit: minutes.

The structure that contains the stack policy body. The stack policy body must be 1 to 16,384 bytes in length.

The name of the stack.

The name can be up to 255 characters in length, and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.

The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can be up to 64 characters in length, and can contain letters, digits, hyphens (-), and underscores (_).

For more information, see Ensure idempotence.

The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in an Alibaba Cloud OSS bucket, for examples, oss://ros/stack-policy/demo and oss://ros/stack-policy/demo?RegionId=cn-hangzhou. The template can be up to 524,288 bytes in length. If you do not specify RegionId in the URL, the region ID of the stack group is used.

The name of the RAM role. ROS assumes the RAM role to create the stack and uses credentials of the role to call the APIs of Alibaba Cloud services.

ROS assumes the RAM role to perform operations on the stack. If you have permissions to perform operations on the stack but you do not have permissions to use the RAM role, ROS still uses the RAM role. You must make sure that the least privileges are granted to the role.

If you do not specify this parameter, ROS uses the existing role that is associated with the stack. If no roles are available for ROS to assume, ROS uses a temporary credential that is generated from the credentials of your account.

The RAM role name can be up to 64 characters in length.

Specifies whether to enable deletion protection on the stack. Default value: Disabled. Valid values:

• Enabled: enables deletion protection on the stack.
• Disabled: disables deletion protection on the stack. You can release the stack by using the ROS console or calling the DeleteStack operation.

Specifies whether to delete the stack after the stack is created. Default value: KeepStackOnCreationComplete. Valid values:

• KeepStackOnCreationComplete: retains the stack and all of its resources after the stack is created.
• AbandonStackOnCreationComplete: deletes the stack but retains all of its resources after the stack is created. This ensures that the maximum number of stacks allowed to be created is not reached. If the stack fails to be created, the stack is retained.
• AbandonStackOnCreationRollbackComplete: deletes the stack after rollback on stack creation failure is complete. This ensures that the maximum number of stacks allowed to be created is not reached. If the stack is created or the rollback fails to complete, the stack is retained.

The ID of the template. This parameter applies to shared and private templates.

The version of the template. This parameter only takes effect if the TemplateId parameter is specified.

The ID of the resource group. If you do not specify this parameter, the stack is added to the default resource group.

For more information about resource groups, see What is Resource Management?

The maximum number of concurrent operations that are performed on resources. This parameter only takes effect for Terraform stacks.

This parameter is empty by default. You can set this parameter to an integer greater than or equal to 0.

The ID of the scenario.

For more information about how to query the IDs of scenarios, see ListTemplateScratches.

The region ID of the scenario. The default value is the same as the value of RegionId.

You can call the DescribeRegions operation to query the most recent region list.

The key of parameter N that is defined in the template. If you do not specify the key and value of the parameter, ROS uses the default key and value in the template.

Maximum value of N: 200.

The value of parameter N that is defined in the template.

Maximum value of N: 200.

The callback URL that is used to receive stack event N. Valid values:

• HTTP POST URL

  Each URL can be up to 1,024 bytes in length.

• eventbridge

  When the status of a stack changes, ROS sends event notifications to the EventBridge service. You can view the event information in the EventBridge console.

  Note ROS supports the EventBridge service in the following regions: China (Hangzhou), China (Shanghai), China (Beijing), China (Hong Kong), and China (Zhangjiakou).

Maximum value of N: 5. ROS sends a notification to the specified URL when the stack status changes. If rollback is enabled on the stack, notifications are sent when the stack is in the CREATE_ROLLBACK or ROLLBACK state, but are not sent when the stack is in the CREATE_FAILED or UPDATE_FAILED state. ROS does not send notifications when the stack is in the IN_PROGRESS state.

Notifications are sent regardless of whether the Outputs parameter is specified. The following sample code shows the content of an event notification:

{
    "Outputs": [
        {
            "Description": "No description given",
            "OutputKey": "InstanceId",
            "OutputValue": "i-xxx"
        }
    ],
    "StackId": "80bd6b6c-e888-4573-ae3b-93d29113****",
    "StackName": "test-notification-url",
    "Status": "CREATE_COMPLETE"
}
                                    

The key of tag N of the stack.

Valid values of N: 1 to 20.

The value of tag N of the stack.

Valid values of N: 1 to 20.

The ID of the request.

The ID of the stack.