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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public Snapshot.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.