Package software.amazon.awssdk.services.lightsail.model

Class CloudFormationStackRecord

java.lang.Object

software.amazon.awssdk.services.lightsail.model.CloudFormationStackRecord

All Implemented Interfaces:

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

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

Describes a CloudFormation stack record created as a result of the create cloud formation stack action.

A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CloudFormationStackRecord.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the CloudFormation stack record.
static CloudFormationStackRecord.Builder	builder()
Instant	createdAt()	The date when the CloudFormation stack record was created.
DestinationInfo	destinationInfo()	A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSourceInfo()	For responses, this returns true if the service returned a value for the SourceInfo property.
ResourceLocation	location()	A list of objects describing the Availability Zone and Amazon Web Services Region of the CloudFormation stack record.
String	name()	The name of the CloudFormation stack record.
ResourceType	resourceType()	The Lightsail resource type (CloudFormationStackRecord).
String	resourceTypeAsString()	The Lightsail resource type (CloudFormationStackRecord).
List<SdkField<?>>	sdkFields()
static Class<? extends CloudFormationStackRecord.Builder>	serializableBuilderClass()
List<CloudFormationStackRecordSourceInfo>	sourceInfo()	A list of objects describing the source of the CloudFormation stack record.
RecordState	state()	The current state of the CloudFormation stack record.
String	stateAsString()	The current state of the CloudFormation stack record.
CloudFormationStackRecord.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

name

public final String name()

The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.

Returns:

The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.

arn

public final String arn()

The Amazon Resource Name (ARN) of the CloudFormation stack record.

Returns:

The Amazon Resource Name (ARN) of the CloudFormation stack record.

createdAt

public final Instant createdAt()

The date when the CloudFormation stack record was created.

Returns:

The date when the CloudFormation stack record was created.

location

public final ResourceLocation location()

A list of objects describing the Availability Zone and Amazon Web Services Region of the CloudFormation stack record.

Returns:

A list of objects describing the Availability Zone and Amazon Web Services Region of the CloudFormation stack record.

resourceType

public final ResourceType resourceType()

The Lightsail resource type (CloudFormationStackRecord).

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

Returns:

The Lightsail resource type (CloudFormationStackRecord).

See Also:

ResourceType

resourceTypeAsString

public final String resourceTypeAsString()

The Lightsail resource type (CloudFormationStackRecord).

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

Returns:

The Lightsail resource type (CloudFormationStackRecord).

See Also:

ResourceType

state

public final RecordState state()

The current state of the CloudFormation stack record.

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

Returns:

The current state of the CloudFormation stack record.

See Also:

RecordState

stateAsString

public final String stateAsString()

The current state of the CloudFormation stack record.

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

Returns:

The current state of the CloudFormation stack record.

See Also:

RecordState

hasSourceInfo

public final boolean hasSourceInfo()

For responses, this returns true if the service returned a value for the SourceInfo 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.

sourceInfo

public final List<CloudFormationStackRecordSourceInfo> sourceInfo()

A list of objects describing the source of the CloudFormation stack record.

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

Returns:

A list of objects describing the source of the CloudFormation stack record.

destinationInfo

public final DestinationInfo destinationInfo()

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.

Returns:

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.

toBuilder

public CloudFormationStackRecord.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CloudFormationStackRecord.Builder,CloudFormationStackRecord>

builder

public static CloudFormationStackRecord.Builder builder()

serializableBuilderClass

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