DBSnapshot (AWS SDK for Java - 2.0.0-preview-11)

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

All Implemented Interfaces:

ToCopyableBuilder<DBSnapshot.Builder,DBSnapshot>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DBSnapshot
extends Object
implements ToCopyableBuilder<DBSnapshot.Builder,DBSnapshot>
```
Contains the details of an Amazon RDS DB snapshot.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DBSnapshot.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DBSnapshot.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 gigabytes (GB).
`String`	`availabilityZone()` Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
`static DBSnapshot.Builder`	`builder()`
`String`	`dbInstanceIdentifier()` Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
`String`	`dbSnapshotArn()` The Amazon Resource Name (ARN) for the DB snapshot.
`String`	`dbSnapshotIdentifier()` Specifies the identifier for the DB snapshot.
`Boolean`	`encrypted()` Specifies whether the DB snapshot is encrypted.
`String`	`engine()` Specifies the name of the database engine.
`String`	`engineVersion()` Specifies the version of the database engine.
`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()` Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
`Integer`	`iops()` Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
`String`	`kmsKeyId()` If `Encrypted` is true, the AWS KMS key identifier for the encrypted DB snapshot.
`String`	`licenseModel()` License model information for the restored DB instance.
`String`	`masterUsername()` Provides the master username for the DB snapshot.
`String`	`optionGroupName()` Provides the option group name for the DB snapshot.
`Integer`	`percentProgress()` The percentage of the estimated data that has been transferred.
`Integer`	`port()` Specifies the port that the database engine was listening on at the time of the snapshot.
`static Class<? extends DBSnapshot.Builder>`	`serializableBuilderClass()`
`Instant`	`snapshotCreateTime()` Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
`String`	`snapshotType()` Provides the type of the DB snapshot.
`String`	`sourceDBSnapshotIdentifier()` The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from.
`String`	`sourceRegion()` The AWS Region that the DB snapshot was created in or copied from.
`String`	`status()` Specifies the status of this DB snapshot.
`String`	`storageType()` Specifies the storage type associated with DB snapshot.
`String`	`tdeCredentialArn()` The ARN from the key store with which to associate the instance for TDE encryption.
`String`	`timezone()` The time zone of the DB snapshot.
`DBSnapshot.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 snapshot.

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
  - dbSnapshotIdentifier
```
public String dbSnapshotIdentifier()
```
    Specifies the identifier for the DB snapshot.
    
    Returns:
    
    Specifies the identifier for the DB snapshot.
  - dbInstanceIdentifier
```
public String dbInstanceIdentifier()
```
    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
    
    Returns:
    
    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
  - snapshotCreateTime
```
public Instant snapshotCreateTime()
```
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - engine
```
public String engine()
```
    Specifies the name of the database engine.
    
    Returns:
    
    Specifies the name of the database engine.
  - allocatedStorage
```
public Integer allocatedStorage()
```
    Specifies the allocated storage size in gigabytes (GB).
    
    Returns:
    
    Specifies the allocated storage size in gigabytes (GB).
  - status
```
public String status()
```
    Specifies the status of this DB snapshot.
    
    Returns:
    
    Specifies the status of this DB snapshot.
  - port
```
public Integer port()
```
    Specifies the port that the database engine was listening on at the time of the snapshot.
    
    Returns:
    
    Specifies the port that the database engine was listening on at the time of the snapshot.
  - availabilityZone
```
public String availabilityZone()
```
    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    
    Returns:
    
    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
  - vpcId
```
public String vpcId()
```
    Provides the VPC ID associated with the DB snapshot.
    
    Returns:
    
    Provides the VPC ID associated with the DB snapshot.
  - instanceCreateTime
```
public Instant instanceCreateTime()
```
    Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - masterUsername
```
public String masterUsername()
```
    Provides the master username for the DB snapshot.
    
    Returns:
    
    Provides the master username for the DB snapshot.
  - engineVersion
```
public String engineVersion()
```
    Specifies the version of the database engine.
    
    Returns:
    
    Specifies the version of the database engine.
  - licenseModel
```
public String licenseModel()
```
    License model information for the restored DB instance.
    
    Returns:
    
    License model information for the restored DB instance.
  - snapshotType
```
public String snapshotType()
```
    Provides the type of the DB snapshot.
    
    Returns:
    
    Provides the type of the DB snapshot.
  - iops
```
public Integer iops()
```
    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    
    Returns:
    
    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
  - optionGroupName
```
public String optionGroupName()
```
    Provides the option group name for the DB snapshot.
    
    Returns:
    
    Provides the option group name for the DB snapshot.
  - percentProgress
```
public Integer percentProgress()
```
    The percentage of the estimated data that has been transferred.
    
    Returns:
    
    The percentage of the estimated data that has been transferred.
  - sourceRegion
```
public String sourceRegion()
```
    The AWS Region that the DB snapshot was created in or copied from.
    
    Returns:
    
    The AWS Region that the DB snapshot was created in or copied from.
  - sourceDBSnapshotIdentifier
```
public String sourceDBSnapshotIdentifier()
```
    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
    
    Returns:
    
    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
  - storageType
```
public String storageType()
```
    Specifies the storage type associated with DB snapshot.
    
    Returns:
    
    Specifies the storage type associated with DB snapshot.
  - tdeCredentialArn
```
public String tdeCredentialArn()
```
    The ARN from the key store with which to associate the instance for TDE encryption.
    
    Returns:
    
    The ARN from the key store with which to associate the instance for TDE encryption.
  - encrypted
```
public Boolean encrypted()
```
    Specifies whether the DB snapshot is encrypted.
    
    Returns:
    
    Specifies whether the DB snapshot is encrypted.
  - kmsKeyId
```
public String kmsKeyId()
```
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
    
    Returns:
    
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
  - dbSnapshotArn
```
public String dbSnapshotArn()
```
    The Amazon Resource Name (ARN) for the DB snapshot.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB snapshot.
  - timezone
```
public String timezone()
```
    The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
    
    Returns:
    
    The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from 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 DBSnapshot.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<DBSnapshot.Builder,DBSnapshot>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DBSnapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBSnapshot.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)
```

Class DBSnapshot

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

dbSnapshotIdentifier

dbInstanceIdentifier

snapshotCreateTime

engine

allocatedStorage

status

port

availabilityZone

vpcId

instanceCreateTime

masterUsername

engineVersion

licenseModel

snapshotType

iops

optionGroupName

percentProgress

sourceRegion

sourceDBSnapshotIdentifier

storageType

tdeCredentialArn

encrypted

kmsKeyId

dbSnapshotArn

timezone

iamDatabaseAuthenticationEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField