Class DBClusterSnapshot

java.lang.Object
software.amazon.awssdk.services.docdb.model.DBClusterSnapshot
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>
@Generated("software.amazon.awssdk:codegen") public final class DBClusterSnapshot extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>

Detailed information about a cluster snapshot.

See Also:

  • Method Details

    • hasAvailabilityZones

      public final boolean hasAvailabilityZones()
      For responses, this returns true if the service returned a value for the AvailabilityZones 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.

    • availabilityZones

      public final List<String> availabilityZones()

      Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

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

      Returns:
      Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

    • dbClusterSnapshotIdentifier

      public final String dbClusterSnapshotIdentifier()

      Specifies the identifier for the cluster snapshot.

      Returns:
      Specifies the identifier for the cluster snapshot.

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

      Returns:
      Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

    • snapshotCreateTime

      public final Instant snapshotCreateTime()

      Provides the time when the snapshot was taken, in UTC.

      Returns:
      Provides the time when the snapshot was taken, in UTC.

    • engine

      public final String engine()

      Specifies the name of the database engine.

      Returns:
      Specifies the name of the database engine.

    • status

      public final String status()

      Specifies the status of this cluster snapshot.

      Returns:
      Specifies the status of this cluster snapshot.

    • port

      public final Integer port()

      Specifies the port that the cluster was listening on at the time of the snapshot.

      Returns:
      Specifies the port that the cluster was listening on at the time of the snapshot.

    • vpcId

      public final String vpcId()

      Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

      Returns:
      Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

    • clusterCreateTime

      public final Instant clusterCreateTime()

      Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

      Returns:
      Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

    • masterUsername

      public final String masterUsername()

      Provides the master user name for the cluster snapshot.

      Returns:
      Provides the master user name for the cluster snapshot.

    • engineVersion

      public final String engineVersion()

      Provides the version of the database engine for this cluster snapshot.

      Returns:
      Provides the version of the database engine for this cluster snapshot.

    • snapshotType

      public final String snapshotType()

      Provides the type of the cluster snapshot.

      Returns:
      Provides the type of the cluster snapshot.

    • percentProgress

      public final Integer percentProgress()

      Specifies the percentage of the estimated data that has been transferred.

      Returns:
      Specifies the percentage of the estimated data that has been transferred.

    • storageEncrypted

      public final Boolean storageEncrypted()

      Specifies whether the cluster snapshot is encrypted.

      Returns:
      Specifies whether the cluster snapshot is encrypted.

    • kmsKeyId

      public final String kmsKeyId()

      If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

      Returns:
      If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

    • dbClusterSnapshotArn

      public final String dbClusterSnapshotArn()

      The Amazon Resource Name (ARN) for the cluster snapshot.

      Returns:
      The Amazon Resource Name (ARN) for the cluster snapshot.

    • sourceDBClusterSnapshotArn

      public final String sourceDBClusterSnapshotArn()

      If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

      Returns:
      If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

    • storageType

      public final String storageType()

      Storage type associated with your cluster snapshot

      For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

      Valid values for storage type - standard | iopt1

      Default value is standard

      Returns:
      Storage type associated with your cluster snapshot

      For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

      Valid values for storage type - standard | iopt1

      Default value is standard

    • toBuilder

      public DBClusterSnapshot.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<DBClusterSnapshot.Builder,DBClusterSnapshot>
      Returns:
      a builder for type T

    • builder

      public static DBClusterSnapshot.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.