You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudFormation::Types::ResourceChange

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The action that AWS 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 cannot be determined).

Possible values:

  • Add
  • Modify
  • Remove
  • Import
  • Dynamic

Returns:

  • (String) —

    The action that AWS 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 cannot be determined).

#change_set_id ⇒ String

The change set ID of the nested change set.

Returns:

  • (String) —

    The change set ID of the nested change set.

#details ⇒ Array<Types::ResourceChangeDetail>

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

Returns:

  • (Array<Types::ResourceChangeDetail>) —

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

#logical_resource_id ⇒ String

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

Returns:

  • (String) —

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

#physical_resource_id ⇒ String

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

Returns:

  • (String) —

    The resource\'s physical ID (resource name).

#replacement ⇒ String

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.

Possible values:

  • True
  • False
  • Conditional

Returns:

  • (String) —

    For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one.

#resource_type ⇒ String

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

Returns:

  • (String) —

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

#scope ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    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.