Package software.amazon.awssdk.services.rds.model

Class DBInstanceAutomatedBackup

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

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

See Also:

  • Method Details

    • dbInstanceArn

      public final String dbInstanceArn()

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

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

    • dbiResourceId

      public final String dbiResourceId()

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

      Returns:
      The resource ID for the source DB instance, 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.

    • dbInstanceIdentifier

      public final String dbInstanceIdentifier()

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

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

    • restoreWindow

      public final RestoreWindow restoreWindow()

      The earliest and latest time a DB instance can be restored to.

      Returns:
      The earliest and latest time a DB instance can be restored to.

    • allocatedStorage

      public final Integer allocatedStorage()

      The allocated storage size for the the automated backup in gibibytes (GiB).

      Returns:
      The allocated storage size for the the automated backup in gibibytes (GiB).

    • status

      public final String status()

      A list of status information for an automated backup:

      • active - Automated backups for current instances.

      • retained - Automated backups for deleted instances.

      • creating - Automated backups that are waiting for the first automated snapshot to be available.

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

      • active - Automated backups for current instances.

      • retained - Automated backups for deleted instances.

      • creating - Automated backups that are waiting for the first automated snapshot to be available.

    • port

      public final Integer port()

      The port number that the automated backup used for connections.

      Default: Inherits from the source DB instance

      Valid Values: 1150-65535

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

      Default: Inherits from the source DB instance

      Valid Values: 1150-65535

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

      Returns:
      The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

    • vpcId

      public final String vpcId()

      The VPC ID associated with the DB instance.

      Returns:
      The VPC ID associated with the DB instance.

    • instanceCreateTime

      public final Instant instanceCreateTime()

      The date and time when the DB instance was created.

      Returns:
      The date and time when the DB instance was created.

    • masterUsername

      public final String masterUsername()

      The master user name of an automated backup.

      Returns:
      The master user name of an automated backup.

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

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

    • licenseModel

      public final String licenseModel()

      The license model information for the automated backup.

      Returns:
      The license model information for the automated backup.

    • iops

      public final Integer iops()

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

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

    • optionGroupName

      public final String optionGroupName()

      The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

      Returns:
      The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

    • tdeCredentialArn

      public final String tdeCredentialArn()

      The ARN from the key store with which the automated backup is associated for TDE encryption.

      Returns:
      The ARN from the key store with which the automated backup is associated for TDE encryption.

    • encrypted

      public final Boolean encrypted()

      Indicates whether the automated backup is encrypted.

      Returns:
      Indicates whether the automated backup is encrypted.

    • storageType

      public final String storageType()

      The storage type associated with the automated backup.

      Returns:
      The storage type associated with the automated backup.

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

    • timezone

      public final String timezone()

      The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

      Returns:
      The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

    • iamDatabaseAuthenticationEnabled

      public final Boolean iamDatabaseAuthenticationEnabled()

      True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      Returns:
      True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • backupRetentionPeriod

      public final Integer backupRetentionPeriod()

      The retention period for the automated backups.

      Returns:
      The retention period for the automated backups.

    • dbInstanceAutomatedBackupsArn

      public final String dbInstanceAutomatedBackupsArn()

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

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

    • hasDbInstanceAutomatedBackupsReplications

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

    • dbInstanceAutomatedBackupsReplications

      public final List<DBInstanceAutomatedBackupsReplication> dbInstanceAutomatedBackupsReplications()

      The list of replications to different Amazon Web Services Regions associated with the automated backup.

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

      Returns:
      The list of replications to different Amazon Web Services Regions associated with the automated backup.

    • backupTarget

      public final String backupTarget()

      The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

      Returns:
      The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

    • storageThroughput

      public final Integer storageThroughput()

      The storage throughput for the automated backup.

      Returns:
      The storage throughput for the automated backup.

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

    • dedicatedLogVolume

      public final Boolean dedicatedLogVolume()

      Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

      Returns:
      Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

    • multiTenant

      public final Boolean multiTenant()

      Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

      Returns:
      Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

    • toBuilder

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

    • builder

      public static DBInstanceAutomatedBackup.Builder builder()

    • serializableBuilderClass

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