ResourceChange¶
Structure Class¶
ResourceChange
dataclass
¶
Bases: _SerdeShape
The ResourceChange structure describes the resource and the action
that CloudFormation will perform on it if you execute this change set.
Attributes¶
action
class-attribute
instance-attribute
¶
action: str | None = ...
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), Dynamic (exact action for
the resource can't be determined), or SyncWithActual (resource will
not be changed, only CloudFormation metadata will change).
after_context
class-attribute
instance-attribute
¶
after_context: str | None = ...
An encoded JSON string that contains the context of the resource after the change is executed.
before_context
class-attribute
instance-attribute
¶
before_context: str | None = ...
An encoded JSON string that contains the context of the resource before the change is executed.
change_set_id
class-attribute
instance-attribute
¶
change_set_id: str | None = ...
The change set ID of the nested change set.
details
class-attribute
instance-attribute
¶
details: list[ResourceChangeDetail] | None = ...
For the Modify action, a list of ResourceChangeDetail structures
that describes the changes that CloudFormation will make to the
resource.
logical_resource_id
class-attribute
instance-attribute
¶
logical_resource_id: str | None = ...
The resource's logical ID, which is defined in the stack's template.
module_info
class-attribute
instance-attribute
¶
module_info: ModuleInfo | None = ...
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
physical_resource_id
class-attribute
instance-attribute
¶
physical_resource_id: str | None = ...
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
policy_action
class-attribute
instance-attribute
¶
policy_action: str | None = ...
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.
previous_deployment_context
class-attribute
instance-attribute
¶
previous_deployment_context: str | None = ...
Information about the resource's state from the previous CloudFormation deployment.
replacement
class-attribute
instance-attribute
¶
replacement: str | None = ...
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 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
Conditional.
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
Conditional, and then Never.
resource_drift_ignored_attributes
class-attribute
instance-attribute
¶
resource_drift_ignored_attributes: list[ResourceDriftIgnoredAttribute] | None = ...
List of resource attributes for which drift was ignored.
resource_drift_status
class-attribute
instance-attribute
¶
resource_drift_status: str | None = ...
The drift status of the resource. Valid values:
-
IN_SYNC-- The resource matches its template definition. -
MODIFIED-- Resource properties were modified outside CloudFormation. -
DELETED-- The resource was deleted outside CloudFormation. -
NOT_CHECKED-- CloudFormation doesn't currently return this value. -
UNKNOWN-- Drift status could not be determined. -
UNSUPPORTED-- Resource type does not support actual state comparison.
Only present for drift-aware change sets.