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

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

Constant Summary collapse

SENSITIVE =
[]

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)

7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  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)

7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  include Aws::Structure
end

#logical_resource_idString

The logical name of the resource specified in the template.

Returns:

  • (String)

7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  include Aws::Structure
end

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


7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  include Aws::Structure
end

#physical_resource_idString

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

Returns:

  • (String)

7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  include Aws::Structure
end

#physical_resource_id_contextArray<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 are not enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.


7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  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:


7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

The type of the resource.

Returns:

  • (String)

7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  include Aws::Structure
end

#stack_idString

The ID of the stack.

Returns:

  • (String)

7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  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`: CloudFormation does not currently return this value.

Returns:

  • (String)

7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  include Aws::Structure
end

#timestampTime

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

Returns:

  • (Time)

7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
# File 'lib/aws-sdk-cloudformation/types.rb', line 7573

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)
  SENSITIVE = []
  include Aws::Structure
end