Class: Aws::CloudFormation::Types::StackResourceDrift

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see [Detect unmanaged configuration changes to stacks and resources with drift detection].

Resources that don’t currently support drift detection can’t be checked. For a list of resources that support drift detection, see [Resource type support for imports and drift detection].

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actual_properties ⇒ String

A JSON structure that contains the actual property values of the stack resource.

For resources whose ‘StackResourceDriftStatus` is `DELETED`, this structure will not be present.

Returns:

  • (String) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#drift_status_reason ⇒ String

The reason for the drift status.

Returns:

  • (String) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#expected_properties ⇒ String

A JSON structure that contains the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

For resources whose ‘StackResourceDriftStatus` is `DELETED`, this structure will not be present.

Returns:

  • (String) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#logical_resource_id ⇒ String

The logical name of the resource specified in the template.

Returns:

  • (String) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  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:



9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#physical_resource_id ⇒ String

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

Returns:

  • (String) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#physical_resource_id_context ⇒ Array<Types::PhysicalResourceIdContextKeyValuePair>

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource’s logical and physical IDs aren’t enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

Returns:



9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#property_differences ⇒ Array<Types::PropertyDifference>

A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose ‘StackResourceDriftStatus` is `MODIFIED`.

Returns:



9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of the resource.

Returns:

  • (String) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The ID of the stack.

Returns:

  • (String) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#stack_resource_drift_status ⇒ String

Status of the resource’s actual configuration compared to its expected configuration.

  • ‘DELETED`: The resource differs from its expected template configuration because the resource has been deleted.

  • ‘MODIFIED`: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

  • ‘IN_SYNC`: The resource’s actual configuration matches its expected template configuration.

  • ‘NOT_CHECKED`: CloudFormation does not currently return this value.

  • ‘UNKNOWN`: CloudFormation could not run drift detection for the resource. See the `DriftStatusReason` for details.

Returns:

  • (String) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ Time

Time at which CloudFormation performed drift detection on the stack resource.

Returns:

  • (Time) 


9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 9276

class StackResourceDrift < Struct.new(
  :stack_id,
  :logical_resource_id,
  :physical_resource_id,
  :physical_resource_id_context,
  :resource_type,
  :expected_properties,
  :actual_properties,
  :property_differences,
  :stack_resource_drift_status,
  :timestamp,
  :module_info,
  :drift_status_reason)
  SENSITIVE = []
  include Aws::Structure
end