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

Class ResourceDetail

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.ResourceDetail

All Implemented Interfaces:

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

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

Details about a resource in a generated template

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceDetail.Builder

Method Summary

Modifier and Type	Method	Description
static ResourceDetail.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceIdentifier()	For responses, this returns true if the service returned a value for the ResourceIdentifier property.
boolean	hasWarnings()	For responses, this returns true if the service returned a value for the Warnings property.
String	logicalResourceId()	The logical id for this resource in the final generated template.
Map<String,String>	resourceIdentifier()	A list of up to 256 key-value pairs that identifies the resource in the generated template.
GeneratedTemplateResourceStatus	resourceStatus()	Status of the processing of a resource in a generated template.
String	resourceStatusAsString()	Status of the processing of a resource in a generated template.
String	resourceStatusReason()	The reason for the resource detail, providing more information if a failure happened.
String	resourceType()	The type of the resource, such as AWS::DynamoDB::Table.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceDetail.Builder>	serializableBuilderClass()
ResourceDetail.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<WarningDetail>	warnings()	The warnings generated for this resource.

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

resourceType

public final String resourceType()

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide

Returns:

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide

logicalResourceId

public final String logicalResourceId()

The logical id for this resource in the final generated template.

Returns:

The logical id for this resource in the final generated template.

hasResourceIdentifier

public final boolean hasResourceIdentifier()

For responses, this returns true if the service returned a value for the ResourceIdentifier property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

resourceIdentifier

public final Map<String,String> resourceIdentifier()

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

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 hasResourceIdentifier() method.

Returns:

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

resourceStatus

public final GeneratedTemplateResourceStatus resourceStatus()

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

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

Returns:

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

See Also:

GeneratedTemplateResourceStatus

resourceStatusAsString

public final String resourceStatusAsString()

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

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

Returns:

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

See Also:

GeneratedTemplateResourceStatus

resourceStatusReason

public final String resourceStatusReason()

The reason for the resource detail, providing more information if a failure happened.

Returns:

The reason for the resource detail, providing more information if a failure happened.

hasWarnings

public final boolean hasWarnings()

For responses, this returns true if the service returned a value for the Warnings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

warnings

public final List<WarningDetail> warnings()

The warnings generated for this 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 hasWarnings() method.

Returns:

The warnings generated for this resource.

toBuilder

public ResourceDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceDetail.Builder,ResourceDetail>

builder

public static ResourceDetail.Builder builder()

serializableBuilderClass

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