Struct aws_sdk_cloudformation::types::ResourceChange

#[non_exhaustive]
pub struct ResourceChange {
    pub policy_action: Option<PolicyAction>,
    pub action: Option<ChangeAction>,
    pub logical_resource_id: Option<String>,
    pub physical_resource_id: Option<String>,
    pub resource_type: Option<String>,
    pub replacement: Option<Replacement>,
    pub scope: Option<Vec<ResourceAttribute>>,
    pub details: Option<Vec<ResourceChangeDetail>>,
    pub change_set_id: Option<String>,
    pub module_info: Option<ModuleInfo>,
    pub before_context: Option<String>,
    pub after_context: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

policy_action: Option<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.

action: Option<ChangeAction>

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), or Dynamic (exact action for the resource can't be determined).

logical_resource_id: Option<String>

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

physical_resource_id: Option<String>

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

resource_type: Option<String>

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

replacement: Option<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 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.

scope: Option<Vec<ResourceAttribute>>

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.

details: Option<Vec<ResourceChangeDetail>>

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

change_set_id: Option<String>

The change set ID of the nested change set.

module_info: Option<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.

before_context: Option<String>

An encoded JSON string containing the context of the resource before the change is executed.

after_context: Option<String>

An encoded JSON string containing the context of the resource after the change is executed.

Implementations

impl ResourceChange

pub fn policy_action(&self) -> Option<&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.

pub fn action(&self) -> Option<&ChangeAction>

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), or Dynamic (exact action for the resource can't be determined).

pub fn logical_resource_id(&self) -> Option<&str>

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

pub fn physical_resource_id(&self) -> Option<&str>

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

pub fn resource_type(&self) -> Option<&str>

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

pub fn replacement(&self) -> Option<&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 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.

pub fn scope(&self) -> &[ResourceAttribute]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .scope.is_none().

pub fn details(&self) -> &[ResourceChangeDetail]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .details.is_none().

pub fn change_set_id(&self) -> Option<&str>

The change set ID of the nested change set.

pub fn module_info(&self) -> Option<&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.

pub fn before_context(&self) -> Option<&str>

An encoded JSON string containing the context of the resource before the change is executed.

pub fn after_context(&self) -> Option<&str>

An encoded JSON string containing the context of the resource after the change is executed.

impl ResourceChange

pub fn builder() -> ResourceChangeBuilder

Creates a new builder-style object to manufacture ResourceChange.

Trait Implementations

impl Clone for ResourceChange

fn clone(&self) -> ResourceChange

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResourceChange

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ResourceChange

fn eq(&self, other: &ResourceChange) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ResourceChange