Resource Orchestration Service:CreateStack

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

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

Default value: false. Valid values:

• true
• false

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 that is located on an HTTP or HTTPS web server or in an Object Storage Service (OSS) bucket, such as oss://ros/stack-policy/demo or oss://ros/stack-policy/demo?RegionId=cn-hangzhou. The policy file can be up to 16,384 bytes in length. If you do not specify the region ID of the OSS bucket, the value of the RegionId parameter is used.

The URL can be up to 1,350 bytes in length.

The timeout period that is allowed to create the stack.

• Default value: 60.
• Unit: minutes.
• Valid values: 10 to 1440.

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 (_). The name must start with a 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 the value 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 OSS bucket, such as oss://ros/stack-policy/demo or oss://ros/stack-policy/demo?RegionId=cn-hangzhou. The template body can be up to 524,288 bytes in length. If you do not specify the region ID of the OSS bucket, the value of the RegionId parameter 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 do not have permissions to use the RAM role, ROS still assumes the RAM role. You must make sure that the least privileges are granted to the RAM role.

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

The name can be up to 64 characters in length.

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

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

The option for the stack after you create the stack. Default value: KeepStackOnCreationComplete. Valid values:

• KeepStackOnCreationComplete: retains the stack and its resources after the stack is created. In this case, your stack quota in ROS is consumed.
• AbandonStackOnCreationComplete: deletes the stack, but retains its resources after the stack is created. In this case, your stack quota in ROS is not consumed. If the stack fails to be created, the stack is retained.
• AbandonStackOnCreationRollbackComplete: deletes the stack when its resources are rolled back after the stack fails to be created. In this case, your stack quota in ROS is not consumed. In other rollback scenarios, the stack is retained.

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

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

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

Maximum value of N: 200.

The name must be 1 to 128 characters in length, and cannot contain http:// or https://. The name cannot start with aliyun or acs:.

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

Maximum value of N: 200.

The value can be up to 128 characters in length, and cannot contain http:// or https://. The value cannot start with aliyun or acs:.

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 an event notification 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. When the status of a stack changes, ROS sends an event notification to the specified URL. When rollback is enabled for the stack, event notifications are sent if the stack is in the CREATE_ROLLBACK or ROLLBACK state, but are not sent if the stack is in the CREATE_FAILED, UPDATE_FAILED, or IN_PROGRESS state.

ROS sends event notifications regardless of whether you configure the Outputs section. The following sample code provides an example on 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 that you want to add to the stack.

Valid values of N: 1 to 20.

The value of tag N that you want to add to the stack.

Valid values of N: 1 to 20.

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 the "Resource Group" section of the What is Resource Management? topic.

The maximum number of concurrent operations that can be performed on resources.

By default, this parameter is empty. You can set this parameter to an integer that is 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 the RegionId parameter.

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

The ID of the request.

The ID of the stack.