CreateStack

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

The key of parameter N that is defined in the template. If the key and value of the parameter are not specified, the key and value in the template are used.

Maximum value of N: 200.

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

Maximum value of N: 200.

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

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 key of tag N of the stack.

Valid values of N: 1 to 20.

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

Default value: false. Valid values:

• true: disables rollback when the stack fails to be created.
• false: enables rollback 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 is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of 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 an Alibaba Cloud OSS bucket. Examples: 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 the region of the OSS bucket is not specified, the RegionId value 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 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 How to ensure idempotence.

The URL of the file that contains the template body. The URL must point to a template located in an HTTP or HTTPS web server or an Alibaba Cloud OSS bucket. Examples: oss://ros/template/demo and oss://ros/template/demo?RegionId=cn-hangzhou. The template must be 1 to 524,288 bytes in length. If the region of the OSS bucket is not specified, the RegionId value is used.

The name of the RAM role. ROS assumes the specified RAM role to create the stack and call API operations by using the credentials of the role.

All operations are performed under this role. If a RAM user is authorized to perform operations on the stack but does not have the permission to use the role, ROS still uses the role and grants the role the least privilege.

If you do not specify this parameter, ROS uses the role previously associated with the stack. If no roles are available, ROS uses the temporary credentials 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 by calling the DeleteStack operation.

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

• KeepStackOnCreationComplete: retains the stack and all its resources after the stack is created.
• AbandonStackOnCreationComplete: deletes the stack but retains all its resources after the stack is created. This helps you ensure 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 helps you ensure 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 takes effect only when 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 a resource group?

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

  An event is sent to the EventBridge service when the stack status changes. To view the events, log on to the EventBridge console and choose System Event Bus > Event Query.

  Note This feature is supported in the China (Hangzhou), China (Shanghai), China (Beijing), China (Hong Kong), and China (Zhangjiakou) regions.

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 if 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 code is an example of a 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 value of tag N.

Valid values of N: 1 to 20.

The ID of the stack.

The ID of the request.