Package software.amazon.awssdk.services.cloudformation.model

Class DescribeStackDriftDetectionStatusResponse

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("software.amazon.awssdk:codegen")
public final class DescribeStackDriftDetectionStatusResponse
extends CloudFormationResponse
implements ToCopyableBuilder<DescribeStackDriftDetectionStatusResponse.Builder,DescribeStackDriftDetectionStatusResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStackDriftDetectionStatusResponse.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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()
String	toString()	Returns a string representation of this object.

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

stackId

public final String stackId()

The ID of the stack.

Returns:

The ID of the stack.

stackDriftDetectionId

public final String stackDriftDetectionId()

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

Returns:

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

stackDriftStatus

public final 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: CloudFormation hasn't 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: CloudFormation hasn't 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 final 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: CloudFormation hasn't 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: CloudFormation hasn't 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 final 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 don't currently support stack detection remain unchecked.)

  If you specified logical resource IDs for 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 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 don't currently support stack detection remain unchecked.)

  If you specified logical resource IDs for 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 CloudFormation successfully completed drift detection.

• DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

See Also:

StackDriftDetectionStatus

detectionStatusAsString

public final 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 don't currently support stack detection remain unchecked.)

  If you specified logical resource IDs for 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 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 don't currently support stack detection remain unchecked.)

  If you specified logical resource IDs for 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 CloudFormation successfully completed drift detection.

• DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

See Also:

StackDriftDetectionStatus

detectionStatusReason

public final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStackDriftDetectionStatusResponse.Builder,DescribeStackDriftDetectionStatusResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeStackDriftDetectionStatusResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeStackDriftDetectionStatusResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo