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

Class StackResource

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.StackResource

All Implemented Interfaces:

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

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

The StackResource data type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StackResource.Builder

Method Summary

Modifier and Type	Method	Description
static StackResource.Builder	builder()
String	description()	User defined description associated with the resource.
StackResourceDriftInformation	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()
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 a resource supported by CloudFormation.
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 StackResource.Builder>	serializableBuilderClass()
String	stackId()	Unique identifier of the stack.
String	stackName()	The name associated with the stack.
Instant	timestamp()	Time the status was updated.
StackResource.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

stackName

public final String stackName()

The name associated with the stack.

Returns:

The name associated with the stack.

stackId

public final String stackId()

Unique identifier of the stack.

Returns:

Unique identifier of the stack.

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.

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.

timestamp

public final Instant timestamp()

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.

description

public final String description()

User defined description associated with the resource.

Returns:

User defined description associated with the resource.

driftInformation

public final StackResourceDriftInformation 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 StackResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StackResource.Builder,StackResource>

builder

public static StackResource.Builder builder()

serializableBuilderClass

public static Class<? extends StackResource.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