StackResourceDrift (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.cloudformation.model.StackResourceDrift

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StackResourceDrift.Builder,StackResourceDrift>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class StackResourceDrift
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StackResourceDrift.Builder,StackResourceDrift>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StackResourceDrift.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StackResourceDrift.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`actualProperties()` A JSON structure containing the actual property values of the stack resource.
`static StackResourceDrift.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`String`	`expectedProperties()` 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.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`logicalResourceId()` The logical name of the resource specified in the template.
`String`	`physicalResourceId()` The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
`List<PhysicalResourceIdContextKeyValuePair>`	`physicalResourceIdContext()` Context information that enables AWS CloudFormation to uniquely identify a resource.
`List<PropertyDifference>`	`propertyDifferences()` A collection of the resource properties whose actual values differ from their expected values.
`String`	`resourceType()` The type of the resource.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StackResourceDrift.Builder>`	`serializableBuilderClass()`
`String`	`stackId()` The ID of the stack.
`StackResourceDriftStatus`	`stackResourceDriftStatus()` Status of the resource's actual configuration compared to its expected configuration
`String`	`stackResourceDriftStatusAsString()` Status of the resource's actual configuration compared to its expected configuration
`Instant`	`timestamp()` Time at which AWS CloudFormation performed drift detection on the stack resource.
`StackResourceDrift.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - stackId
```
public String stackId()
```
    The ID of the stack.
    
    Returns:
    
    The ID of the stack.
  - logicalResourceId
```
public String logicalResourceId()
```
    The logical name of the resource specified in the template.
    
    Returns:
    
    The logical name of the resource specified in the template.
  - physicalResourceId
```
public String physicalResourceId()
```
    The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
    
    Returns:
    
    The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
  - physicalResourceIdContext
```
public List<PhysicalResourceIdContextKeyValuePair> physicalResourceIdContext()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - resourceType
```
public String resourceType()
```
    The type of the resource.
    
    Returns:
    
    The type of the resource.
  - expectedProperties
```
public String expectedProperties()
```
    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:
    
    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.
  - actualProperties
```
public String actualProperties()
```
    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:
    
    A JSON structure containing the actual property values of the stack resource.
    
    For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.
  - propertyDifferences
```
public List<PropertyDifference> propertyDifferences()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - stackResourceDriftStatus
```
public StackResourceDriftStatus stackResourceDriftStatus()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, stackResourceDriftStatus will return StackResourceDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stackResourceDriftStatusAsString().
    Returns:
    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.
    See Also:
    
    StackResourceDriftStatus
  - stackResourceDriftStatusAsString
```
public String stackResourceDriftStatusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, stackResourceDriftStatus will return StackResourceDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stackResourceDriftStatusAsString().
    Returns:
    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.
    See Also:
    
    StackResourceDriftStatus
  - timestamp
```
public Instant timestamp()
```
    Time at which AWS CloudFormation performed drift detection on the stack resource.
    
    Returns:
    
    Time at which AWS CloudFormation performed drift detection on the stack resource.
  - toBuilder
```
public StackResourceDrift.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StackResourceDrift.Builder,StackResourceDrift>
    
    Returns:
    
    a builder for type T
  - builder
```
public static StackResourceDrift.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StackResourceDrift.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class StackResourceDrift

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

stackId

logicalResourceId

physicalResourceId

physicalResourceIdContext

resourceType

expectedProperties

actualProperties

propertyDifferences

stackResourceDriftStatus

stackResourceDriftStatusAsString

timestamp

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields