ResourceChange
The ResourceChange
structure describes the resource and the action that
CloudFormation will perform on it if you execute this change set.
Contents
- Action
-
The action that CloudFormation takes on the resource, such as
Add
(adds a new resource),Modify
(changes a resource),Remove
(deletes a resource),Import
(imports a resource), orDynamic
(exact action for the resource can't be determined).Type: String
Valid Values:
Add | Modify | Remove | Import | Dynamic
Required: No
- AfterContext
-
An encoded JSON string containing the context of the resource after the change is executed.
Type: String
Required: No
- BeforeContext
-
An encoded JSON string containing the context of the resource before the change is executed.
Type: String
Required: No
- ChangeSetId
-
The change set ID of the nested change set.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
arn:[-a-zA-Z0-9:/]*
Required: No
- Details.member.N
-
For the
Modify
action, a list ofResourceChangeDetail
structures that describes the changes that 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
- ModuleInfo
-
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
Type: ModuleInfo object
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
- PolicyAction
-
The action that will be taken on the physical resource when the change set is executed.
-
Delete
The resource will be deleted. -
Retain
The resource will be retained. -
Snapshot
The resource will have a snapshot taken. -
ReplaceAndDelete
The resource will be replaced and then deleted. -
ReplaceAndRetain
The resource will be replaced and then retained. -
ReplaceAndSnapshot
The resource will be replaced and then have a snapshot taken.
Type: String
Valid Values:
Delete | Retain | Snapshot | ReplaceAndDelete | ReplaceAndRetain | ReplaceAndSnapshot
Required: No
-
- Replacement
-
For the
Modify
action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditional
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditional
, and thenNever
.Type: String
Valid Values:
True | False | Conditional
Required: No
- ResourceType
-
The type of 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'sMetadata
,Properties
, orTags
.Type: Array of strings
Valid Values:
Properties | Metadata | CreationPolicy | UpdatePolicy | DeletionPolicy | UpdateReplacePolicy | Tags
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: