Class DBClusterAutomatedBackup

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

An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.

See Also:

  • Method Details

    • engine

      public final String engine()

      The name of the database engine for this automated backup.

      Returns:
      The name of the database engine for this automated backup.

    • vpcId

      public final String vpcId()

      The VPC ID associated with the DB cluster.

      Returns:
      The VPC ID associated with the DB cluster.

    • dbClusterAutomatedBackupsArn

      public final String dbClusterAutomatedBackupsArn()

      The Amazon Resource Name (ARN) for the automated backups.

      Returns:
      The Amazon Resource Name (ARN) for the automated backups.

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

      Returns:
      The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

    • restoreWindow

      public final RestoreWindow restoreWindow()
      Returns the value of the RestoreWindow property for this object.
      Returns:
      The value of the RestoreWindow property for this object.

    • masterUsername

      public final String masterUsername()

      The master user name of the automated backup.

      Returns:
      The master user name of the automated backup.

    • dbClusterResourceId

      public final String dbClusterResourceId()

      The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

      Returns:
      The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

    • region

      public final String region()

      The Amazon Web Services Region associated with the automated backup.

      Returns:
      The Amazon Web Services Region associated with the automated backup.

    • licenseModel

      public final String licenseModel()

      The license model information for this DB cluster automated backup.

      Returns:
      The license model information for this DB cluster automated backup.

    • status

      public final String status()

      A list of status information for an automated backup:

      • retained - Automated backups for deleted clusters.

      Returns:
      A list of status information for an automated backup:

      • retained - Automated backups for deleted clusters.

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

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

    • storageEncrypted

      public final Boolean storageEncrypted()

      Indicates whether the source DB cluster is encrypted.

      Returns:
      Indicates whether the source DB cluster is encrypted.

    • allocatedStorage

      public final Integer allocatedStorage()

      For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      Returns:
      For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

    • engineVersion

      public final String engineVersion()

      The version of the database engine for the automated backup.

      Returns:
      The version of the database engine for the automated backup.

    • dbClusterArn

      public final String dbClusterArn()

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

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

    • backupRetentionPeriod

      public final Integer backupRetentionPeriod()

      The retention period for the automated backups.

      Returns:
      The retention period for the automated backups.

    • engineMode

      public final String engineMode()

      The engine mode of the database engine for the automated backup.

      Returns:
      The engine mode of the database engine for the automated backup.

    • 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 Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

      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 Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

    • port

      public final Integer port()

      The port number that the automated backup used for connections.

      Default: Inherits from the source DB cluster

      Valid Values: 1150-65535

      Returns:
      The port number that the automated backup used for connections.

      Default: Inherits from the source DB cluster

      Valid Values: 1150-65535

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services KMS key ID for an automated backup.

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

      Returns:
      The Amazon Web Services KMS key ID for an automated backup.

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

    • storageType

      public final String storageType()

      The storage type associated with the DB cluster.

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

      Returns:
      The storage type associated with the DB cluster.

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

    • iops

      public final Integer iops()

      The IOPS (I/O operations per second) value for the automated backup.

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

      Returns:
      The IOPS (I/O operations per second) value for the automated backup.

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

    • awsBackupRecoveryPointArn

      public final String awsBackupRecoveryPointArn()

      The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

      Returns:
      The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

    • storageThroughput

      public final Integer storageThroughput()

      The storage throughput for the automated backup. 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 automated backup. 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 DBClusterAutomatedBackup.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<DBClusterAutomatedBackup.Builder,DBClusterAutomatedBackup>
      Returns:
      a builder for type T

    • builder

      public static DBClusterAutomatedBackup.Builder builder()

    • serializableBuilderClass

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