Class DBClusterSnapshot

java.lang.Object
software.amazon.awssdk.services.rds.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>

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

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()

      The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

      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:
      The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    • dbClusterSnapshotIdentifier

      public final String dbClusterSnapshotIdentifier()

      The identifier for the DB cluster snapshot.

      Returns:
      The identifier for the DB cluster snapshot.
    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

      Returns:
      The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
    • snapshotCreateTime

      public final Instant snapshotCreateTime()

      The time when the snapshot was taken, in Universal Coordinated Time (UTC).

      Returns:
      The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    • engine

      public final String engine()

      The name of the database engine for this DB cluster snapshot.

      Returns:
      The name of the database engine for this DB cluster snapshot.
    • engineMode

      public final String engineMode()

      The engine mode of the database engine for this DB cluster snapshot.

      Returns:
      The engine mode of the database engine for this DB cluster snapshot.
    • allocatedStorage

      public final Integer allocatedStorage()

      The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

      Returns:
      The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    • status

      public final String status()

      The status of this DB cluster snapshot. Valid statuses are the following:

      • available

      • copying

      • creating

      Returns:
      The status of this DB cluster snapshot. Valid statuses are the following:

      • available

      • copying

      • creating

    • port

      public final Integer port()

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

      Returns:
      The port that the DB cluster was listening on at the time of the snapshot.
    • vpcId

      public final String vpcId()

      The VPC ID associated with the DB cluster snapshot.

      Returns:
      The VPC ID associated with the DB cluster snapshot.
    • clusterCreateTime

      public final Instant clusterCreateTime()

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

      Returns:
      The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    • masterUsername

      public final String masterUsername()

      The master username for this DB cluster snapshot.

      Returns:
      The master username for this DB cluster snapshot.
    • engineVersion

      public final String engineVersion()

      The version of the database engine for this DB cluster snapshot.

      Returns:
      The version of the database engine for this DB cluster snapshot.
    • licenseModel

      public final String licenseModel()

      The license model information for this DB cluster snapshot.

      Returns:
      The license model information for this DB cluster snapshot.
    • snapshotType

      public final String snapshotType()

      The type of the DB cluster snapshot.

      Returns:
      The type of the DB cluster snapshot.
    • percentProgress

      public final Integer percentProgress()

      The percentage of the estimated data that has been transferred.

      Returns:
      The percentage of the estimated data that has been transferred.
    • storageEncrypted

      public final Boolean storageEncrypted()

      Indicates whether the DB cluster snapshot is encrypted.

      Returns:
      Indicates whether the DB cluster snapshot is encrypted.
    • kmsKeyId

      public final String kmsKeyId()

      If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • dbClusterSnapshotArn

      public final String dbClusterSnapshotArn()

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

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

      public final String sourceDBClusterSnapshotArn()

      If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

      Returns:
      If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
    • iamDatabaseAuthenticationEnabled

      public final Boolean iamDatabaseAuthenticationEnabled()

      Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      Returns:
      Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
    • hasTagList

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

      public final List<Tag> tagList()
      Returns the value of the TagList property for this object.

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

      Returns:
      The value of the TagList property for this object.
    • dbSystemId

      public final String dbSystemId()

      Reserved for future use.

      Returns:
      Reserved for future use.
    • storageType

      public final String storageType()

      The storage type associated with the DB cluster snapshot.

      This setting is only for Aurora DB clusters.

      Returns:
      The storage type associated with the DB cluster snapshot.

      This setting is only for Aurora DB clusters.

    • dbClusterResourceId

      public final String dbClusterResourceId()

      The resource ID of the DB cluster that this DB cluster snapshot was created from.

      Returns:
      The resource ID of the DB cluster that this DB cluster snapshot was created from.
    • storageThroughput

      public final Integer storageThroughput()

      The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

      This setting is only for non-Aurora Multi-AZ DB clusters.

      Returns:
      The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

      This setting is only for non-Aurora Multi-AZ DB clusters.

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