StackResourceDrift (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudformation.model.StackResourceDrift

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StackResourceDrift
extends Object
implements Serializable, Cloneable
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StackResourceDrift()

Constructors
Constructor and Description
`StackResourceDrift()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StackResourceDrift`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getActualProperties()` A JSON structure containing the actual property values of the stack resource.
`String`	`getExpectedProperties()` 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.
`String`	`getLogicalResourceId()` The logical name of the resource specified in the template.
`String`	`getPhysicalResourceId()` The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
`List<PhysicalResourceIdContextKeyValuePair>`	`getPhysicalResourceIdContext()` Context information that enables AWS CloudFormation to uniquely identify a resource.
`List<PropertyDifference>`	`getPropertyDifferences()` A collection of the resource properties whose actual values differ from their expected values.
`String`	`getResourceType()` The type of the resource.
`String`	`getStackId()` The ID of the stack.
`String`	`getStackResourceDriftStatus()` Status of the resource's actual configuration compared to its expected configuration
`Date`	`getTimestamp()` Time at which AWS CloudFormation performed drift detection on the stack resource.
`int`	`hashCode()`
`void`	`setActualProperties(String actualProperties)` A JSON structure containing the actual property values of the stack resource.
`void`	`setExpectedProperties(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.
`void`	`setLogicalResourceId(String logicalResourceId)` The logical name of the resource specified in the template.
`void`	`setPhysicalResourceId(String physicalResourceId)` The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
`void`	`setPhysicalResourceIdContext(Collection<PhysicalResourceIdContextKeyValuePair> physicalResourceIdContext)` Context information that enables AWS CloudFormation to uniquely identify a resource.
`void`	`setPropertyDifferences(Collection<PropertyDifference> propertyDifferences)` A collection of the resource properties whose actual values differ from their expected values.
`void`	`setResourceType(String resourceType)` The type of the resource.
`void`	`setStackId(String stackId)` The ID of the stack.
`void`	`setStackResourceDriftStatus(String stackResourceDriftStatus)` Status of the resource's actual configuration compared to its expected configuration
`void`	`setTimestamp(Date timestamp)` Time at which AWS CloudFormation performed drift detection on the stack resource.
`String`	`toString()` Returns a string representation of this object.
`StackResourceDrift`	`withActualProperties(String actualProperties)` A JSON structure containing the actual property values of the stack resource.
`StackResourceDrift`	`withExpectedProperties(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.
`StackResourceDrift`	`withLogicalResourceId(String logicalResourceId)` The logical name of the resource specified in the template.
`StackResourceDrift`	`withPhysicalResourceId(String physicalResourceId)` The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
`StackResourceDrift`	`withPhysicalResourceIdContext(Collection<PhysicalResourceIdContextKeyValuePair> physicalResourceIdContext)` Context information that enables AWS CloudFormation to uniquely identify a resource.
`StackResourceDrift`	`withPhysicalResourceIdContext(PhysicalResourceIdContextKeyValuePair... physicalResourceIdContext)` Context information that enables AWS CloudFormation to uniquely identify a resource.
`StackResourceDrift`	`withPropertyDifferences(Collection<PropertyDifference> propertyDifferences)` A collection of the resource properties whose actual values differ from their expected values.
`StackResourceDrift`	`withPropertyDifferences(PropertyDifference... propertyDifferences)` A collection of the resource properties whose actual values differ from their expected values.
`StackResourceDrift`	`withResourceType(String resourceType)` The type of the resource.
`StackResourceDrift`	`withStackId(String stackId)` The ID of the stack.
`StackResourceDrift`	`withStackResourceDriftStatus(StackResourceDriftStatus stackResourceDriftStatus)` Status of the resource's actual configuration compared to its expected configuration
`StackResourceDrift`	`withStackResourceDriftStatus(String stackResourceDriftStatus)` Status of the resource's actual configuration compared to its expected configuration
`StackResourceDrift`	`withTimestamp(Date timestamp)` Time at which AWS CloudFormation performed drift detection on the stack resource.

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

- Constructor Detail
  - StackResourceDrift
```
public StackResourceDrift()
```
- Method Detail
  - setStackId
```
public void setStackId(String stackId)
```
    The ID of the stack.
    
    Parameters:
    
    stackId - The ID of the stack.
  - getStackId
```
public String getStackId()
```
    The ID of the stack.
    
    Returns:
    
    The ID of the stack.
  - withStackId
```
public StackResourceDrift withStackId(String stackId)
```
    The ID of the stack.
    
    Parameters:
    
    stackId - The ID of the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogicalResourceId
```
public void setLogicalResourceId(String logicalResourceId)
```
    The logical name of the resource specified in the template.
    
    Parameters:
    
    logicalResourceId - The logical name of the resource specified in the template.
  - getLogicalResourceId
```
public String getLogicalResourceId()
```
    The logical name of the resource specified in the template.
    
    Returns:
    
    The logical name of the resource specified in the template.
  - withLogicalResourceId
```
public StackResourceDrift withLogicalResourceId(String logicalResourceId)
```
    The logical name of the resource specified in the template.
    
    Parameters:
    
    logicalResourceId - The logical name of the resource specified in the template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPhysicalResourceId
```
public void setPhysicalResourceId(String physicalResourceId)
```
    The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
    
    Parameters:
    
    physicalResourceId - The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
  - getPhysicalResourceId
```
public String getPhysicalResourceId()
```
    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.
  - withPhysicalResourceId
```
public StackResourceDrift withPhysicalResourceId(String physicalResourceId)
```
    The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
    
    Parameters:
    
    physicalResourceId - The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPhysicalResourceIdContext
```
public List<PhysicalResourceIdContextKeyValuePair> getPhysicalResourceIdContext()
```
    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.
    
    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.
  - setPhysicalResourceIdContext
```
public void setPhysicalResourceIdContext(Collection<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.
    
    Parameters:
    
    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.
  - withPhysicalResourceIdContext
```
public StackResourceDrift withPhysicalResourceIdContext(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setPhysicalResourceIdContext(java.util.Collection) or withPhysicalResourceIdContext(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPhysicalResourceIdContext
```
public StackResourceDrift withPhysicalResourceIdContext(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The type of the resource.
    
    Parameters:
    
    resourceType - The type of the resource.
  - getResourceType
```
public String getResourceType()
```
    The type of the resource.
    
    Returns:
    
    The type of the resource.
  - withResourceType
```
public StackResourceDrift withResourceType(String resourceType)
```
    The type of the resource.
    
    Parameters:
    
    resourceType - The type of the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpectedProperties
```
public void setExpectedProperties(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.
    
    Parameters:
    
    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.
  - getExpectedProperties
```
public String getExpectedProperties()
```
    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.
  - withExpectedProperties
```
public StackResourceDrift withExpectedProperties(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActualProperties
```
public void setActualProperties(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.
    
    Parameters:
    
    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.
  - getActualProperties
```
public String getActualProperties()
```
    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.
  - withActualProperties
```
public StackResourceDrift withActualProperties(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPropertyDifferences
```
public List<PropertyDifference> getPropertyDifferences()
```
    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:
    
    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.
  - setPropertyDifferences
```
public void setPropertyDifferences(Collection<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.
    
    Parameters:
    
    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.
  - withPropertyDifferences
```
public StackResourceDrift withPropertyDifferences(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setPropertyDifferences(java.util.Collection) or withPropertyDifferences(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPropertyDifferences
```
public StackResourceDrift withPropertyDifferences(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStackResourceDriftStatus
```
public void setStackResourceDriftStatus(String 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.
    Parameters:
    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.
    See Also:
    
    StackResourceDriftStatus
  - getStackResourceDriftStatus
```
public String getStackResourceDriftStatus()
```
    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:
    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
  - withStackResourceDriftStatus
```
public StackResourceDrift withStackResourceDriftStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackResourceDriftStatus
  - withStackResourceDriftStatus
```
public StackResourceDrift withStackResourceDriftStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackResourceDriftStatus
  - setTimestamp
```
public void setTimestamp(Date timestamp)
```
    Time at which AWS CloudFormation performed drift detection on the stack resource.
    
    Parameters:
    
    timestamp - Time at which AWS CloudFormation performed drift detection on the stack resource.
  - getTimestamp
```
public Date getTimestamp()
```
    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.
  - withTimestamp
```
public StackResourceDrift withTimestamp(Date timestamp)
```
    Time at which AWS CloudFormation performed drift detection on the stack resource.
    
    Parameters:
    
    timestamp - Time at which AWS CloudFormation performed drift detection on the stack resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StackResourceDrift clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class StackResourceDrift

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StackResourceDrift

Method Detail

setStackId

getStackId

withStackId

setLogicalResourceId

getLogicalResourceId

withLogicalResourceId

setPhysicalResourceId

getPhysicalResourceId

withPhysicalResourceId

getPhysicalResourceIdContext

setPhysicalResourceIdContext

withPhysicalResourceIdContext

withPhysicalResourceIdContext

setResourceType

getResourceType

withResourceType

setExpectedProperties

getExpectedProperties

withExpectedProperties

setActualProperties

getActualProperties

withActualProperties

getPropertyDifferences

setPropertyDifferences

withPropertyDifferences

withPropertyDifferences

setStackResourceDriftStatus

getStackResourceDriftStatus

withStackResourceDriftStatus

withStackResourceDriftStatus

setTimestamp

getTimestamp

withTimestamp

toString

equals

hashCode

clone