CreateChangeSet

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

The ID of the stack for which you want to create the change set. ROS compares the stack information with the information that you specify, such as a modified template or different values of input parameters, to generate the change set.

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 Alibaba Cloud Object Storage Service (OSS) bucket, for example, oss://ros/stack-policy/demo and oss://ros/stack-policy/demo?RegionId=cn-hangzhou. The policy file can be up to 16,384 bytes in length.

You can specify the StackPolicyBody or StackPolicyURL parameter.

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

If you set the ChangeSetType parameter to CREATE, you can specify the StackPolicyBody or StackPolicyURL parameter. If you set the ChangeSetType parameter to UPDATE, you can specify only one of the following parameters:

• StackPolicyBody
• StackPolicyURL
• StackPolicyDuringUpdateBody
• StackPolicyDuringUpdateURL

The structure that contains the stack policy body. The policy body must be 1 to 16,384 bytes in length. If you set the ChangeSetType parameter to CREATE, you can specify the StackPolicyBody or StackPolicyURL parameter. If you set the ChangeSetType parameter to UPDATE, you can specify only one of the following parameters:

• StackPolicyBody
• StackPolicyURL
• StackPolicyDuringUpdateBody
• StackPolicyDuringUpdateURL

The name of the stack for which you want to create the change set.

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

Specifies whether to use the values that you specified last time for the parameters that you do not specify in the request. Default value: false. Valid values:

• true
• false

The type of the change set. Default value: UPDATE. Valid values:

• CREATE: creates a change set for a new stack.
• UPDATE: creates a change set for an existing stack.
• IMPORT: creates a change set for a new stack or an existing stack to import resources that are not managed by ROS.

If you create a change set for a new stack, ROS generates a unique stack ID for the stack. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set.

If you want to create a change set for a new stack, do not set the ChangeSetType parameter to UPDATE. If you want to create a change set for an existing stack, do not set the ChangeSetType parameter to CREATE.

The description of the change set. The description can be up to 1,024 bytes in length.

The region ID of the change set. 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 example, oss://ros/template/demo and oss://ros/template/demo?RegionId=cn-hangzhou. The template body can be up to 524,288 bytes in length.

You can specify only one of the following parameters: TemplateBody, TemplateURL, and TemplateId.

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

The URL of the file that contains the stack policy based on which the stack is updated. The URL must point to a policy that is located on 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 file can be up to 16,384 bytes in length.

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

If you need to update protected resources, specify a temporary overriding stack policy for the resources during the update. If you do not specify a stack policy, the existing policy that is associated with the stack is used. This parameter only takes effect when the ChangeSetType parameter is set to UPDATE. You can specify only one of the following parameters:

• StackPolicyBody
• StackPolicyURL
• StackPolicyDuringUpdateBody
• StackPolicyDuringUpdateURL

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.

You can specify only one of the following parameters: TemplateBody, TemplateURL, and TemplateId.

The amount of time that can elapse before the stack enters the CREATE_FAILED or UPDATE_FAILED state.

If you set the ChangeSetType parameter to CREATE, this parameter is required. If you set the ChangeSetType parameter to UPDATE, this parameter is optional.

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

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

Default value: false. Valid values:

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

The name of the change set.

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

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

If you need to update protected resources, specify a temporary overriding stack policy for the resources during the update. If you do not specify a temporary overriding stack policy, the existing stack policy that is associated with the stack is used.

This parameter only takes effect when the ChangeSetType parameter is set to UPDATE. You can specify only one of the following parameters:

• StackPolicyBody
• StackPolicyURL
• StackPolicyDuringUpdateBody
• StackPolicyDuringUpdateURL

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 name of the RAM role can be up to 64 bytes in length.

Specifies whether to enable replacement update if a resource property is changed but you cannot change the resource property. For a change, the physical ID of the resource remains unchanged. For a replacement update, the existing resource is deleted, a new resource is created, and the physical ID of the resource is changed. Default value: Disabled. Valid values:

• Enabled: enables replacement update.
• Disabled: disables replacement update.

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

You can specify only one of the following parameters: TemplateBody, TemplateURL, and TemplateId.

The version of the template.

The ID of the template that is created for a scenario.

The maximum number of concurrent operations that are performed on resources in a Terraform stack. By default, this parameter is empty. You can set this parameter to an integer greater than or equal to 0. If you specify this parameter, ROS associates the value with the stack. The value can affect subsequent operations on the stack.

This parameter only takes effect when the ChangeSetType parameter is set to CREATE or UPDATE.

• Valid values if you set the ChangeSetType parameter to CREATE:
  • If you set the Parallelism parameter to an integer that is greater than 0, the integer is used.
  • If you set the Parallelism parameter to 0 or do not specify the Parallelism parameter, the default value of Terraform is used. In most cases, the default value of Terraform is 10.
• Valid values if you set the ChangeSetType parameter to UPDATE:
  • If you set the Parallelism parameter to an integer that is greater than 0, the integer is used.
  • If you set the Parallelism parameter to 0, the default value of Terraform is used. In most cases, the default value of Terraform is 10.
  • If you do not specify the Parallelism parameter, the value that you specified for this parameter in the last operation is used. If you did not specify this parameter in the last operation, the default value of Terraform is used. In most cases, the default value of Terraform is 10.

The name of parameter N that is defined in the template. If you do not specify a name and a value for a parameter, ROS uses the default name and value that are specified 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 event N for the stack. 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. To view the event information, perform the following operations: Log on to the EventBridge console. In the left-side navigation pane, click Event Buses.

  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 event notifications. If rollback is enabled for the stack and the stack is in the CREATE_ROLLBACK or ROLLBACK state, ROS sends event notifications. If rollback is enabled for the stack and the stack is in the CREATE_FAILED, UPDATE_FAILED, or IN_PROGRESS state, ROS does not send event notifications.

ROS sends event notifications regardless of whether you specify the parameters in the Outputs section. 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-value mapping between strings. The mapping is used to identify resource N that you want to import. Set the value of this parameter to a JSON string.

A key is an identifier for a resource and a value is an assignment of data to the key. For example, VpcId is a key that indicates the ID of a virtual private cloud (VPC), and vpc-2zevx9ios**** is a value that is assigned to VpcId. You can call the GetTemplateSummary operation to obtain the key of a resource.

The logical ID of resource N. The logical ID specifies the name of the resource.

The type of resource N. The type must be the same as the type that is defined in the template.

The ID of the change set.

The ID of the request.

The ID of the stack.