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

Class StackResourceSummary

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.StackResourceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StackResourceSummary.Builder,StackResourceSummary>

@Generated("software.amazon.awssdk:codegen")
public final class StackResourceSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StackResourceSummary.Builder,StackResourceSummary>

Contains high-level information about the specified stack resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StackResourceSummary.Builder

Method Summary

Modifier and Type	Method	Description
static StackResourceSummary.Builder	builder()
StackResourceDriftInformationSummary	driftInformation()	Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedTimestamp()	Time the status was updated.
String	logicalResourceId()	The logical name of the resource specified in the template.
ModuleInfo	moduleInfo()	Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
String	physicalResourceId()	The name or unique identifier that corresponds to a physical instance ID of the resource.
ResourceStatus	resourceStatus()	Current status of the resource.
String	resourceStatusAsString()	Current status of the resource.
String	resourceStatusReason()	Success/failure message associated with the resource.
String	resourceType()	Type of resource.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StackResourceSummary.Builder>	serializableBuilderClass()
StackResourceSummary.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

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 the resource.

Returns:

The name or unique identifier that corresponds to a physical instance ID of the 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.)

lastUpdatedTimestamp

public final Instant lastUpdatedTimestamp()

Time the status was updated.

Returns:

Time the status was updated.

resourceStatus

public final ResourceStatus resourceStatus()

Current status of the resource.

If the service returns an enum value that is not available in the current SDK version, resourceStatus will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceStatusAsString().

Returns:

Current status of the resource.

See Also:

ResourceStatus

resourceStatusAsString

public final String resourceStatusAsString()

Current status of the resource.

If the service returns an enum value that is not available in the current SDK version, resourceStatus will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceStatusAsString().

Returns:

Current status of the resource.

See Also:

ResourceStatus

resourceStatusReason

public final String resourceStatusReason()

Success/failure message associated with the resource.

Returns:

Success/failure message associated with the resource.

driftInformation

public final StackResourceDriftInformationSummary driftInformation()

Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

Returns:

Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

moduleInfo

public final ModuleInfo moduleInfo()

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

Returns:

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

toBuilder

public StackResourceSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StackResourceSummary.Builder,StackResourceSummary>

builder

public static StackResourceSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo