Resource Orchestration Service:CreateStack

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

Valid values:

• true
• false (default)

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 RegionId is used.

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

The timeout period for creating the stack.

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

The structure that contains the stack policy body. The 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 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 token, but you must make sure that the token 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/template/demo or oss://ros/template/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 RegionId is used.

The name of the RAM role. ROS assumes the RAM role to create the stack and uses the 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 RAM role name can be up to 64 characters in length.

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

• Enabled.
• Disabled (default). If deletion protection is disabled, you can delete the stack by using the ROS console or by calling the DeleteStack operation.

The creation option for the stack. Valid values:

• KeepStackOnCreationComplete (default): After the stack is created, the stack and its resources are retained. The quota for the maximum number of stacks that can be created in ROS is consumed.
• AbandonStackOnCreationComplete: After the stack is created, the stack is deleted, but its resources are retained. The quota for the maximum number of stacks that can be created in ROS is not consumed. If the stack fails to be created, the stack is retained.
• AbandonStackOnCreationRollbackComplete: When the resources of the stack are rolled back after the stack fails to be created, the stack is deleted. The quota for the maximum number of stacks that can be created in ROS is not consumed. In other rollback scenarios, the stack is retained.
• ManuallyPay: When you create the stack, you must manually pay for the subscription resources that are used. The following resource types support manual payment: ALIYUN::ECS::InstanceGroup, ALIYUN::RDS::DBInstance, ALIYUN::SLB::LoadBalancer, ALIYUN::VPC::EIP, and ALIYUN::VPC::VpnGateway.

The creation options for the stack.

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

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

The parameters that are defined in the template.

The callback URLs that are used to receive stack events. 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 notifications to the EventBridge service. You can view the event information in the EventBridge console.

Maximum value of N: 5. When the status of a stack changes, ROS sends a notification to the specified URL. When rollback is enabled for the stack, 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 notifications regardless of whether you specify the Outputs section. The following sample code provides an example on the content 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 tags that you want to add to the stack.

The ID of the resource group. If you leave this parameter empty, 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 scenario ID.

For more information about how to query the scenario ID, 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.