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

Class ResourceToImport

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.ResourceToImport

All Implemented Interfaces:

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

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

Describes the target resource of an import operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceToImport.Builder

Method Summary

Modifier and Type	Method	Description
static ResourceToImport.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.
String	logicalResourceId()	The logical ID of the target resource as specified in the template.
Map<String,String>	resourceIdentifier()	A key-value pair that identifies the target resource.
String	resourceType()	The type of resource to import into your stack, such as AWS::S3::Bucket.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceToImport.Builder>	serializableBuilderClass()
ResourceToImport.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

resourceType

public final String resourceType()

The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resource type support for imports and drift detection in the CloudFormation User Guide.

Returns:

The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resource type support for imports and drift detection in the CloudFormation User Guide.

logicalResourceId

public final String logicalResourceId()

The logical ID of the target resource as specified in the template.

Returns:

The logical ID of the target resource as specified in the 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 key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

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 key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

toBuilder

public ResourceToImport.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceToImport.Builder,ResourceToImport>

builder

public static ResourceToImport.Builder builder()

serializableBuilderClass

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