DBInstanceAutomatedBackup (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.rds.model.DBInstanceAutomatedBackup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBInstanceAutomatedBackup.Builder,DBInstanceAutomatedBackup>
```
@Generated(value="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 it consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DBInstanceAutomatedBackup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DBInstanceAutomatedBackup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`allocatedStorage()` Specifies the allocated storage size in gibibytes (GiB).
`String`	`availabilityZone()` The Availability Zone that the automated backup was created in.
`static DBInstanceAutomatedBackup.Builder`	`builder()`
`String`	`dbInstanceArn()` The Amazon Resource Name (ARN) for the automated backup.
`String`	`dbInstanceIdentifier()` The customer id of the instance that is/was associated with the automated backup.
`String`	`dbiResourceId()` The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
`Boolean`	`encrypted()` Specifies whether the automated backup is encrypted.
`String`	`engine()` The name of the database engine for this automated backup.
`String`	`engineVersion()` The version of the database engine for the automated backup.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`iamDatabaseAuthenticationEnabled()` True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
`Instant`	`instanceCreateTime()` Provides the date and time that the DB instance was created.
`Integer`	`iops()` The IOPS (I/O operations per second) value for the automated backup.
`String`	`kmsKeyId()` The AWS KMS key ID for an automated backup.
`String`	`licenseModel()` License model information for the automated backup.
`String`	`masterUsername()` The license model of an automated backup.
`String`	`optionGroupName()` The option group the automated backup is associated with.
`Integer`	`port()` The port number that the automated backup used for connections.
`String`	`region()` The AWS Region associated with the automated backup.
`RestoreWindow`	`restoreWindow()` Earliest and latest time an instance can be restored to.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DBInstanceAutomatedBackup.Builder>`	`serializableBuilderClass()`
`String`	`status()` Provides a list of status information for an automated backup:
`String`	`storageType()` Specifies the storage type associated with the automated backup.
`String`	`tdeCredentialArn()` The ARN from the key store with which the automated backup is associated for TDE encryption.
`String`	`timezone()` The time zone of the automated backup.
`DBInstanceAutomatedBackup.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`vpcId()` Provides the VPC ID associated with the DB instance

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbInstanceArn
```
public String dbInstanceArn()
```
    The Amazon Resource Name (ARN) for the automated backup.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the automated backup.
  - dbiResourceId
```
public String dbiResourceId()
```
    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
    
    Returns:
    
    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
  - region
```
public String region()
```
    The AWS Region associated with the automated backup.
    
    Returns:
    
    The AWS Region associated with the automated backup.
  - dbInstanceIdentifier
```
public String dbInstanceIdentifier()
```
    The customer id of the instance that is/was associated with the automated backup.
    
    Returns:
    
    The customer id of the instance that is/was associated with the automated backup.
  - restoreWindow
```
public RestoreWindow restoreWindow()
```
    Earliest and latest time an instance can be restored to.
    
    Returns:
    
    Earliest and latest time an instance can be restored to.
  - allocatedStorage
```
public Integer allocatedStorage()
```
    Specifies the allocated storage size in gibibytes (GiB).
    
    Returns:
    
    Specifies the allocated storage size in gibibytes (GiB).
  - status
```
public String status()
```
    Provides 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:
    Provides 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 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 String availabilityZone()
```
    The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
    
    Returns:
    
    The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
  - vpcId
```
public String vpcId()
```
    Provides the VPC ID associated with the DB instance
    
    Returns:
    
    Provides the VPC ID associated with the DB instance
  - instanceCreateTime
```
public Instant instanceCreateTime()
```
    Provides the date and time that the DB instance was created.
    
    Returns:
    
    Provides the date and time that the DB instance was created.
  - masterUsername
```
public String masterUsername()
```
    The license model of an automated backup.
    
    Returns:
    
    The license model of an automated backup.
  - engine
```
public 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 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 String licenseModel()
```
    License model information for the automated backup.
    
    Returns:
    
    License model information for the automated backup.
  - iops
```
public 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 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 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 Boolean encrypted()
```
    Specifies whether the automated backup is encrypted.
    
    Returns:
    
    Specifies whether the automated backup is encrypted.
  - storageType
```
public String storageType()
```
    Specifies the storage type associated with the automated backup.
    
    Returns:
    
    Specifies the storage type associated with the automated backup.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
    
    Returns:
    
    The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
  - timezone
```
public 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 Boolean iamDatabaseAuthenticationEnabled()
```
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    Returns:
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class DBInstanceAutomatedBackup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbInstanceArn

dbiResourceId

region

dbInstanceIdentifier

restoreWindow

allocatedStorage

status

port

availabilityZone

vpcId

instanceCreateTime

masterUsername

engine

engineVersion

licenseModel

iops

optionGroupName

tdeCredentialArn

encrypted

storageType

kmsKeyId

timezone

iamDatabaseAuthenticationEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields