CreateChangeSet

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

The name of the change set.

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 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 by default. 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 change set. You can call the DescribeRegions operation to query the most recent region list.

The logical ID of the resource as defined in the template.

The key-value mappings from string to string. The parameter value is a JSON string that identifies the resource to be used.

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 VPC, and vpc-2zevx9ios is a value assigned to VpcId. You can call the GetTemplateSummary operation to obtain the key of a resource.

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

The ID of the stack for which you want to create the change set. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different inputs.

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. The policy file can be up to 16,384 bytes in length. Example: oss://ros/stack-policy/demo or oss://ros/stack-policy/demo?RegionId=cn-hangzhou.

You must specify one of the StackPolicyBody and StackPolicyURL parameters, but you cannot specify both of them.

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

When ChangeSetType is set to CREATE, you can specify one of the StackPolicyBody and StackPolicyURL parameters, but you cannot specify both of them. When ChangeSetType is set to UPDATE, you can specify only one of the following parameters:

• StackPolicyBody
• StackPolicyURL
• StackPolicyDuringUpdateBody
• StackPolicyDuringUpdateURL

The structure that contains the stack policy body. The stack policy body must be 1 to 16,384 bytes in length. When ChangeSetType is set to CREATE, you can specify only one of the StackPolicyBody and StackPolicyURL parameters. When ChangeSetType is set 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 (_). It must start with a digit or letter.

Specifies whether to use the values that were passed last time for the parameters that you do not specify in the current 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 non-ROS-managed resources.

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

You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

The description of the change set. The description can be up to 1,024 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. The template can be up to 524,288 bytes in length. Example: oss://ros/template/demo or oss://ros/template/demo?RegionId=cn-hangzhou.

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

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

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. The policy file can be up to 16,384 bytes in length. Example: oss://ros/stack-policy/demo or oss://ros/stack-policy/demo?RegionId=cn-hangzhou.

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

To update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack is used. This parameter takes effect only when ChangeSetType 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 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.

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

The amount of time that can elapse before the stack status changes to CREATE_FAILED or UPDATE_FAILED.

When ChangeSetType is set to CREATE, this parameter is required. When ChangeSetType is set to UPDATE, this parameter is optional.

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

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 body of the temporary overriding stack policy. The stack policy body must be 1 to 16,384 bytes in length.

To update protected resources, specify a temporary overriding stack policy to take effect during the update. If no stack policy is specified for this parameter, the current policy associated with the stack is used.

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

• StackPolicyBody
• StackPolicyURL
• StackPolicyDuringUpdateBody
• StackPolicyDuringUpdateURL

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 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 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 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 replacement update if a resource property that does not support modification update changes but the physical ID of the resource remains unchanged. Note that if the resource is deleted and then recreated, its physical ID changes. 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 TemplateBody, TemplateURL, and TemplateId parameters.

The version of the template.

The ID of the change set.

The ID of the stack.

The ID of the request.