Class StackInstanceResourceDriftsSummary
- java.lang.Object
-
- software.amazon.awssdk.services.cloudformation.model.StackInstanceResourceDriftsSummary
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StackInstanceResourceDriftsSummary.Builder,StackInstanceResourceDriftsSummary>
@Generated("software.amazon.awssdk:codegen") public final class StackInstanceResourceDriftsSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StackInstanceResourceDriftsSummary.Builder,StackInstanceResourceDriftsSummary>
The structure containing summary information about resource drifts for a stack instance.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StackInstanceResourceDriftsSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StackInstanceResourceDriftsSummary.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasPhysicalResourceIdContext()
For responses, this returns true if the service returned a value for the PhysicalResourceIdContext property.boolean
hasPropertyDifferences()
For responses, this returns true if the service returned a value for the PropertyDifferences property.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 CloudFormation.List<PhysicalResourceIdContextKeyValuePair>
physicalResourceIdContext()
Context information that enables CloudFormation to uniquely identify a resource.List<PropertyDifference>
propertyDifferences()
Status of the actual configuration of the resource compared to its expected configuration.String
resourceType()
Type of resource.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends StackInstanceResourceDriftsSummary.Builder>
serializableBuilderClass()
String
stackId()
The ID of the stack instance.StackResourceDriftStatus
stackResourceDriftStatus()
The drift status of the resource in a stack instance.String
stackResourceDriftStatusAsString()
The drift status of the resource in a stack instance.Instant
timestamp()
Time at which the stack instance drift detection operation was initiated.StackInstanceResourceDriftsSummary.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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 instance.
- Returns:
- The ID of the stack instance.
-
logicalResourceId
public final 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 final String physicalResourceId()
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
- Returns:
- The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
-
hasPhysicalResourceIdContext
public final boolean hasPhysicalResourceIdContext()
For responses, this returns true if the service returned a value for the PhysicalResourceIdContext property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
physicalResourceIdContext
public final List<PhysicalResourceIdContextKeyValuePair> physicalResourceIdContext()
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 aren't 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPhysicalResourceIdContext()
method.- Returns:
- 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 aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.
-
resourceType
public final String resourceType()
Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
- Returns:
- Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
-
hasPropertyDifferences
public final boolean hasPropertyDifferences()
For responses, this returns true if the service returned a value for the PropertyDifferences property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
propertyDifferences
public final List<PropertyDifference> propertyDifferences()
Status of the actual configuration of the resource compared to its expected configuration. These will be present only for resources whose
StackInstanceResourceDriftStatus
isMODIFIED
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPropertyDifferences()
method.- Returns:
- Status of the actual configuration of the resource compared to its expected configuration. These will be
present only for resources whose
StackInstanceResourceDriftStatus
isMODIFIED
.
-
stackResourceDriftStatus
public final StackResourceDriftStatus stackResourceDriftStatus()
The drift status of the resource in a stack instance.
-
DELETED
: The resource differs from its expected template configuration in that the resource has been deleted. -
MODIFIED
: One or more resource properties differ from their expected template values. -
IN_SYNC
: The resource's actual configuration matches its expected template configuration. -
NOT_CHECKED
: CloudFormation doesn't currently return this value.
If the service returns an enum value that is not available in the current SDK version,
stackResourceDriftStatus
will returnStackResourceDriftStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstackResourceDriftStatusAsString()
.- Returns:
- The drift status of the resource in a stack instance.
-
DELETED
: The resource differs from its expected template configuration in that the resource has been deleted. -
MODIFIED
: One or more resource properties differ from their expected template values. -
IN_SYNC
: The resource's actual configuration matches its expected template configuration. -
NOT_CHECKED
: CloudFormation doesn't currently return this value.
-
- See Also:
StackResourceDriftStatus
-
-
stackResourceDriftStatusAsString
public final String stackResourceDriftStatusAsString()
The drift status of the resource in a stack instance.
-
DELETED
: The resource differs from its expected template configuration in that the resource has been deleted. -
MODIFIED
: One or more resource properties differ from their expected template values. -
IN_SYNC
: The resource's actual configuration matches its expected template configuration. -
NOT_CHECKED
: CloudFormation doesn't currently return this value.
If the service returns an enum value that is not available in the current SDK version,
stackResourceDriftStatus
will returnStackResourceDriftStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstackResourceDriftStatusAsString()
.- Returns:
- The drift status of the resource in a stack instance.
-
DELETED
: The resource differs from its expected template configuration in that the resource has been deleted. -
MODIFIED
: One or more resource properties differ from their expected template values. -
IN_SYNC
: The resource's actual configuration matches its expected template configuration. -
NOT_CHECKED
: CloudFormation doesn't currently return this value.
-
- See Also:
StackResourceDriftStatus
-
-
timestamp
public final Instant timestamp()
Time at which the stack instance drift detection operation was initiated.
- Returns:
- Time at which the stack instance drift detection operation was initiated.
-
toBuilder
public StackInstanceResourceDriftsSummary.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StackInstanceResourceDriftsSummary.Builder,StackInstanceResourceDriftsSummary>
-
builder
public static StackInstanceResourceDriftsSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends StackInstanceResourceDriftsSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-