This topic describes five data structures of change sets: Change, ResourceChange, ResourceChangeDetail, ResourceTargetDefinition, and ResourcePropertyChange.
Change
Parameter | Type | Description |
---|---|---|
ResourceChange | Structure | The resource that you want Resource Orchestration Service (ROS) to change and the operation that you want ROS to perform on the resource. |
Type | String | The type of the object that you want ROS to change.
Set the value to |
ResourceChange
Parameter | Type | Description |
---|---|---|
Action | String | The operation that you want ROS to perform on the resource. Valid values:
|
Details | Array | The details of changes that are made to the resource. This parameter takes effect
only if you set the Action parameter to Modify .
Note This parameter is available only for ROS stacks.
|
LogicalResourceId | String | The logical ID of the resource. The logical ID specifies the resource name that is defined in the template. |
PhysicalResourceId | String | The physical ID of the resource. This parameter takes effect only if you set the Action parameter to Modify or Remove .
|
Replacement | String | Specifies whether to change the resource by creating a new resource and deleting the
existing resource. This parameter takes effect only if you set the Action parameter to Modify .
|
ResourceType | String | The type of the resource. |
Scope | String array | The parameter for which ROS triggers an update. This parameter takes effect only if
you set the Action parameter to Modify . Valid values:
Note This parameter is available only for ROS stacks.
|
PropertyChanges | The structure array of ResourcePropertyChange | The changes that are made to a resource property. This parameter takes effect only
if you set the Action parameter to Modify .
Note This parameter is available only for Terraform stacks.
|
ResourceChangeDetail
Parameter | Type | Description |
---|---|---|
ChangeSource | String | The reason why ROS triggers an update. Valid values:
|
CausingEntity | String | The object that is associated with the ChangeSource parameter. The following information describes the relationship between the values
of the ChangeSource and CausingEntity parameters:
|
Evaluation | String | Specifies whether ROS can determine the value that you want to change for the object
and whether ROS updates the value before you execute a change set. Valid values:
|
Target | Structure | The details of the object for which ROS triggers an update. |
ResourceTargetDefinition
Parameter | Type | Description |
---|---|---|
Attribute | String | The parameter for which ROS triggers an update. Valid values:
|
Name | String | If you set the Attribute parameter to Properties , the value of the Name parameter is the property name. In other cases, the value
of the Name parameter is empty .
|
RequiresRecreation | String | Specifies whether a change to the property causes the resource to be recreated. This
parameter takes effect only if you set the Attribute parameter to Properties . Valid values:
|
ResourcePropertyChange
Parameter | Type | Description |
---|---|---|
Name | String. | The name of the property. |
BeforeValue | The data type varies based on the property. | The value of the property before ROS updates the property. |
AfterValue | The data type varies based on the property. | The value of the property after the property is updated.
Note
|