Package software.amazon.awssdk.services.memorydb.model

Class Snapshot

java.lang.Object

software.amazon.awssdk.services.memorydb.model.Snapshot

All Implemented Interfaces:

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

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

Represents a copy of an entire cluster as of the time when the snapshot was taken.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Snapshot.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The ARN (Amazon Resource Name) of the snapshot.
static Snapshot.Builder	builder()
ClusterConfiguration	clusterConfiguration()	The configuration of the cluster from which the snapshot was taken
DataTieringStatus	dataTiering()	Enables data tiering.
String	dataTieringAsString()	Enables data tiering.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId()	The ID of the KMS key used to encrypt the snapshot.
String	name()	The name of the snapshot
List<SdkField<?>>	sdkFields()
static Class<? extends Snapshot.Builder>	serializableBuilderClass()
String	source()	Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
String	status()	The status of the snapshot.
Snapshot.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 snapshot

Returns:

The name of the snapshot

status

public final String status()

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

Returns:

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

source

public final String source()

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

Returns:

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

kmsKeyId

public final String kmsKeyId()

The ID of the KMS key used to encrypt the snapshot.

Returns:

The ID of the KMS key used to encrypt the snapshot.

arn

public final String arn()

The ARN (Amazon Resource Name) of the snapshot.

Returns:

The ARN (Amazon Resource Name) of the snapshot.

clusterConfiguration

public final ClusterConfiguration clusterConfiguration()

The configuration of the cluster from which the snapshot was taken

Returns:

The configuration of the cluster from which the snapshot was taken

dataTiering

public final DataTieringStatus dataTiering()

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

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

Returns:

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

See Also:

DataTieringStatus

dataTieringAsString

public final String dataTieringAsString()

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

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

Returns:

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

See Also:

DataTieringStatus

toBuilder

public Snapshot.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>

builder

public static Snapshot.Builder builder()

serializableBuilderClass

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