DescribeStackDriftDetectionStatusResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
    - - software.amazon.awssdk.services.cloudformation.model.DescribeStackDriftDetectionStatusResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeStackDriftDetectionStatusResponse.Builder,DescribeStackDriftDetectionStatusResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeStackDriftDetectionStatusResponse
extends CloudFormationResponse
implements ToCopyableBuilder<DescribeStackDriftDetectionStatusResponse.Builder,DescribeStackDriftDetectionStatusResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeStackDriftDetectionStatusResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeStackDriftDetectionStatusResponse.Builder`	`builder()`
`StackDriftDetectionStatus`	`detectionStatus()` The status of the stack drift detection operation.
`String`	`detectionStatusAsString()` The status of the stack drift detection operation.
`String`	`detectionStatusReason()` The reason the stack drift detection operation has its current status.
`Integer`	`driftedStackResourceCount()` Total number of stack resources that have drifted.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeStackDriftDetectionStatusResponse.Builder>`	`serializableBuilderClass()`
`String`	`stackDriftDetectionId()` The ID of the drift detection results of this operation.
`StackDriftStatus`	`stackDriftStatus()` Status of the stack's actual configuration compared to its expected configuration.
`String`	`stackDriftStatusAsString()` Status of the stack's actual configuration compared to its expected configuration.
`String`	`stackId()` The ID of the stack.
`Instant`	`timestamp()` Time at which the stack drift detection operation was initiated.
`DescribeStackDriftDetectionStatusResponse.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 software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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.
  - stackDriftDetectionId
```
public String stackDriftDetectionId()
```
    The ID of the drift detection results of this operation.
    
    AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary.
    
    Returns:
    
    The ID of the drift detection results of this operation.
    
    AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary.
  - stackDriftStatus
```
public StackDriftStatus stackDriftStatus()
```
    Status of the stack's actual configuration compared to its expected configuration.
    - DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
    - NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration.
    - IN_SYNC: The stack's actual configuration matches its expected template configuration.
    - UNKNOWN: This value is reserved for future use.
    If the service returns an enum value that is not available in the current SDK version, stackDriftStatus will return StackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stackDriftStatusAsString().
    Returns:
    Status of the stack's actual configuration compared to its expected configuration.
    
    DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
    
    NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration.
    
    IN_SYNC: The stack's actual configuration matches its expected template configuration.
    
    UNKNOWN: This value is reserved for future use.
    See Also:
    
    StackDriftStatus
  - stackDriftStatusAsString
```
public String stackDriftStatusAsString()
```
    Status of the stack's actual configuration compared to its expected configuration.
    - DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
    - NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration.
    - IN_SYNC: The stack's actual configuration matches its expected template configuration.
    - UNKNOWN: This value is reserved for future use.
    If the service returns an enum value that is not available in the current SDK version, stackDriftStatus will return StackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stackDriftStatusAsString().
    Returns:
    Status of the stack's actual configuration compared to its expected configuration.
    
    DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
    
    NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration.
    
    IN_SYNC: The stack's actual configuration matches its expected template configuration.
    
    UNKNOWN: This value is reserved for future use.
    See Also:
    
    StackDriftStatus
  - detectionStatus
```
public StackDriftDetectionStatus detectionStatus()
```
    The status of the stack drift detection operation.
    - DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.)
      
      If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
    - DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection.
    - DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
    If the service returns an enum value that is not available in the current SDK version, detectionStatus will return StackDriftDetectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from detectionStatusAsString().
    Returns:
    The status of the stack drift detection operation.
    
    DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.)
    
    If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
    
    DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection.
    
    DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
    See Also:
    
    StackDriftDetectionStatus
  - detectionStatusAsString
```
public String detectionStatusAsString()
```
    The status of the stack drift detection operation.
    - DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.)
      
      If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
    - DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection.
    - DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
    If the service returns an enum value that is not available in the current SDK version, detectionStatus will return StackDriftDetectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from detectionStatusAsString().
    Returns:
    The status of the stack drift detection operation.
    
    DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.)
    
    If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
    
    DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection.
    
    DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
    See Also:
    
    StackDriftDetectionStatus
  - detectionStatusReason
```
public String detectionStatusReason()
```
    The reason the stack drift detection operation has its current status.
    
    Returns:
    
    The reason the stack drift detection operation has its current status.
  - driftedStackResourceCount
```
public Integer driftedStackResourceCount()
```
    Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.
    
    Returns:
    
    Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.
  - timestamp
```
public Instant timestamp()
```
    Time at which the stack drift detection operation was initiated.
    
    Returns:
    
    Time at which the stack drift detection operation was initiated.
  - toBuilder
```
public DescribeStackDriftDetectionStatusResponse.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<DescribeStackDriftDetectionStatusResponse.Builder,DescribeStackDriftDetectionStatusResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeStackDriftDetectionStatusResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeStackDriftDetectionStatusResponse.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)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - 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 DescribeStackDriftDetectionStatusResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

stackId

stackDriftDetectionId

stackDriftStatus

stackDriftStatusAsString

detectionStatus

detectionStatusAsString

detectionStatusReason

driftedStackResourceCount

timestamp

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields