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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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 AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support 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.

Instance Attribute Summary collapse

Instance Attribute Details

#actual_propertiesString

A JSON structure containing the actual property values of the stack resource.

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

Returns:

  • (String)


4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#expected_propertiesString

A JSON structure containing 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)


4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#logical_resource_idString

The logical name of the resource specified in the template.

Returns:

  • (String)


4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#physical_resource_idString

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

Returns:

  • (String)


4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#physical_resource_id_contextArray<Types::PhysicalResourceIdContextKeyValuePair>

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



4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#property_differencesArray<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:



4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#resource_typeString

The type of the resource.

Returns:

  • (String)


4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#stack_idString

The ID of the stack.

Returns:

  • (String)


4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#stack_resource_drift_statusString

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 resources's actual configuration matches its expected template configuration.

  • NOT_CHECKED: AWS CloudFormation does not currently return this value.

Returns:

  • (String)


4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end

#timestampTime

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

Returns:

  • (Time)


4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4547

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)
  include Aws::Structure
end