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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::ResourceChange

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action ⇒ String

  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).

• #after_context ⇒ String

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

• #before_context ⇒ String

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

• #change_set_id ⇒ 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 CloudFormation will make to the resource.

• #logical_resource_id ⇒ String

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

• #module_info ⇒ Types::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.

• #physical_resource_id ⇒ String

  The resource’s physical ID (resource name).

• #policy_action ⇒ String

  The action that will be taken on the physical resource when the change set is executed.

• #replacement ⇒ String

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

• #resource_type ⇒ String

  The type of 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`.

Instance Attribute Details

#action ⇒ String

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).

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#after_context ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#before_context ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#change_set_id ⇒ String

The change set ID of the nested change set.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#details ⇒ Array<Types::ResourceChangeDetail>

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

Returns:

• (Array<Types::ResourceChangeDetail>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#logical_resource_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#module_info ⇒ Types::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.

Returns:

• (Types::ModuleInfo)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#policy_action ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#replacement ⇒ String

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`.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 6672

class ResourceChange < Struct.new(
  :policy_action,
  :action,
  :logical_resource_id,
  :physical_resource_id,
  :resource_type,
  :replacement,
  :scope,
  :details,
  :change_set_id,
  :module_info,
  :before_context,
  :after_context)
  SENSITIVE = []
  include Aws::Structure
end