Class: Aws::CloudFormation::Types::StackRefactorAction

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::StackRefactorAction

Defined in:

gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

Describes the stack and the action that CloudFormation will perform on it if you execute the stack refactor.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action ⇒ String

  The action that CloudFormation takes on the stack.

• #description ⇒ String

  A description to help you identify the refactor.

• #detection ⇒ String

  The detection type is one of the following:.

• #detection_reason ⇒ String

  The description of the detection type.

• #entity ⇒ String

  The type that will be evaluated in the StackRefactorAction.

• #physical_resource_id ⇒ String

  The name or unique identifier associated with the physical instance of the resource.

• #resource_identifier ⇒ String

  A key-value pair that identifies the target resource.

• #resource_mapping ⇒ Types::ResourceMapping

  The mapping for the stack resource Source and stack resource Destination.

• #tag_resources ⇒ Array<Types::Tag>

  Assigns one or more tags to specified resources.

• #untag_resources ⇒ Array<String>

  Removes one or more tags to specified resources.

Instance Attribute Details

#action ⇒ String

The action that CloudFormation takes on the stack.

Returns:

• (String)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description to help you identify the refactor.

Returns:

• (String)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#detection ⇒ String

The detection type is one of the following:

• Auto: CloudFormation figured out the mapping on its own.

• Manual: The customer provided the mapping in the ResourceMapping parameter.

Returns:

• (String)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#detection_reason ⇒ String

The description of the detection type.

Returns:

• (String)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#entity ⇒ String

The type that will be evaluated in the StackRefactorAction. The following are potential Entity types:

• Stack

• Resource

Returns:

• (String)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#physical_resource_id ⇒ String

The name or unique identifier associated with the physical instance of the resource.

Returns:

• (String)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifier ⇒ String

A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

Returns:

• (String)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#resource_mapping ⇒ Types::ResourceMapping

The mapping for the stack resource Source and stack resource Destination.

Returns:

• (Types::ResourceMapping)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#tag_resources ⇒ Array<Types::Tag>

Assigns one or more tags to specified resources.

Returns:

• (Array<Types::Tag>)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end

#untag_resources ⇒ Array<String>

Removes one or more tags to specified resources.

Returns:

• (Array<String>)

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

class StackRefactorAction < Struct.new(
  :action,
  :entity,
  :physical_resource_id,
  :resource_identifier,
  :description,
  :detection,
  :detection_reason,
  :tag_resources,
  :untag_resources,
  :resource_mapping)
  SENSITIVE = []
  include Aws::Structure
end