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 | DynamicRequired: No
- AfterContext
-
An encoded JSON string that contains the context of the resource after the change is executed.
Type: String
Required: No
- BeforeContext
-
An encoded JSON string that contains 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
Modifyaction, a list ofResourceChangeDetailstructures 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.
-
DeleteThe resource will be deleted. -
RetainThe resource will be retained. -
SnapshotThe resource will have a snapshot taken. -
ReplaceAndDeleteThe resource will be replaced and then deleted. -
ReplaceAndRetainThe resource will be replaced and then retained. -
ReplaceAndSnapshotThe resource will be replaced and then have a snapshot taken.
Type: String
Valid Values:
Delete | Retain | Snapshot | ReplaceAndDelete | ReplaceAndRetain | ReplaceAndSnapshotRequired: No
-
- Replacement
-
For the
Modifyaction, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreationproperty in theResourceTargetDefinitionstructure. For example, if theRequiresRecreationfield isAlwaysand theEvaluationfield isStatic,ReplacementisTrue. If theRequiresRecreationfield isAlwaysand theEvaluationfield isDynamic,ReplacementisConditional.If you have multiple changes with different
RequiresRecreationvalues, theReplacementvalue depends on the change with the most impact. ARequiresRecreationvalue ofAlwayshas the most impact, followed byConditional, and thenNever.Type: String
Valid Values:
True | False | ConditionalRequired: 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
Modifyaction, 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 | TagsRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: