Menu
AWS CloudFormation
API Reference (API Version 2010-05-15)

ResourceChange

The ResourceChange structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.

Contents

Action

The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

Type: String

Valid Values: Add | Modify | Remove

Required: No

Details.member.N

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

Type: array of ResourceChangeDetail objects

Required: No

LogicalResourceId

The resource's logical ID, which is defined in the stack's template.

Type: String

Required: No

PhysicalResourceId

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

Type: String

Required: No

Replacement

For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

Type: String

Valid Values: True | False | Conditional

Required: No

ResourceType

The type of AWS CloudFormation resource, such as AWS::S3::Bucket.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Scope.member.N

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

Type: array of Strings

Valid Values: Properties | Metadata | CreationPolicy | UpdatePolicy | DeletionPolicy | Tags

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: