DBSnapshot (AWS Java SDK :: Services :: Amazon RDS 2.17.295 API)

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBSnapshot.Builder,DBSnapshot>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DBSnapshot
extends Object
implements SdkPojo, Serializable, 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.

See Also:

Serialized Form

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 gibibytes (GiB).
`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`	`dbiResourceId()` The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
`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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasProcessorFeatures()` For responses, this returns true if the service returned a value for the ProcessorFeatures property.
`boolean`	`hasTagList()` For responses, this returns true if the service returned a value for the TagList property.
`Boolean`	`iamDatabaseAuthenticationEnabled()` True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
`Instant`	`instanceCreateTime()` Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
`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 Amazon Web Services 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.
`Instant`	`originalSnapshotCreateTime()` Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC).
`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.
`List<ProcessorFeature>`	`processorFeatures()` The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DBSnapshot.Builder>`	`serializableBuilderClass()`
`Instant`	`snapshotCreateTime()` Specifies when the snapshot was taken in Coordinated Universal Time (UTC).
`Instant`	`snapshotDatabaseTime()` The timestamp of the most recent transaction applied to the database that you're backing up.
`String`	`snapshotTarget()` Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
`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 Amazon Web Services 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.
`List<Tag>`	`tagList()` Returns the value of the TagList property for this object.
`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()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` Provides the VPC ID associated with the DB snapshot.

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

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

- Method Detail
  - dbSnapshotIdentifier
```
public final String dbSnapshotIdentifier()
```
    Specifies the identifier for the DB snapshot.
    
    Returns:
    
    Specifies the identifier for the DB snapshot.
  - dbInstanceIdentifier
```
public final 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 final Instant snapshotCreateTime()
```
    Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
    
    Returns:
    
    Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
  - engine
```
public final String engine()
```
    Specifies the name of the database engine.
    
    Returns:
    
    Specifies the name of the database engine.
  - allocatedStorage
```
public final Integer allocatedStorage()
```
    Specifies the allocated storage size in gibibytes (GiB).
    
    Returns:
    
    Specifies the allocated storage size in gibibytes (GiB).
  - status
```
public final String status()
```
    Specifies the status of this DB snapshot.
    
    Returns:
    
    Specifies the status of this DB snapshot.
  - port
```
public final 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 final 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 final String vpcId()
```
    Provides the VPC ID associated with the DB snapshot.
    
    Returns:
    
    Provides the VPC ID associated with the DB snapshot.
  - instanceCreateTime
```
public final Instant instanceCreateTime()
```
    Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
    
    Returns:
    
    Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
  - masterUsername
```
public final String masterUsername()
```
    Provides the master username for the DB snapshot.
    
    Returns:
    
    Provides the master username for the DB snapshot.
  - engineVersion
```
public final String engineVersion()
```
    Specifies the version of the database engine.
    
    Returns:
    
    Specifies the version of the database engine.
  - licenseModel
```
public final String licenseModel()
```
    License model information for the restored DB instance.
    
    Returns:
    
    License model information for the restored DB instance.
  - snapshotType
```
public final String snapshotType()
```
    Provides the type of the DB snapshot.
    
    Returns:
    
    Provides the type of the DB snapshot.
  - iops
```
public final 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 final String optionGroupName()
```
    Provides the option group name for the DB snapshot.
    
    Returns:
    
    Provides the option group name for the DB 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.
  - sourceRegion
```
public final String sourceRegion()
```
    The Amazon Web Services Region that the DB snapshot was created in or copied from.
    
    Returns:
    
    The Amazon Web Services Region that the DB snapshot was created in or copied from.
  - sourceDBSnapshotIdentifier
```
public final String sourceDBSnapshotIdentifier()
```
    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
    
    Returns:
    
    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
  - storageType
```
public final String storageType()
```
    Specifies the storage type associated with DB snapshot.
    
    Returns:
    
    Specifies the storage type associated with DB snapshot.
  - tdeCredentialArn
```
public final 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 final Boolean encrypted()
```
    Specifies whether the DB snapshot is encrypted.
    
    Returns:
    
    Specifies whether the DB snapshot is encrypted.
  - kmsKeyId
```
public final String kmsKeyId()
```
    If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB 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 Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
  - dbSnapshotArn
```
public final String dbSnapshotArn()
```
    The Amazon Resource Name (ARN) for the DB snapshot.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB snapshot.
  - timezone
```
public final 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 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.
  - hasProcessorFeatures
```
public final boolean hasProcessorFeatures()
```
    For responses, this returns true if the service returned a value for the ProcessorFeatures 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.
  - processorFeatures
```
public final List<ProcessorFeature> processorFeatures()
```
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
    
    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 hasProcessorFeatures() method.
    
    Returns:
    
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
  - dbiResourceId
```
public final String dbiResourceId()
```
    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.
  - 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.
  - originalSnapshotCreateTime
```
public final Instant originalSnapshotCreateTime()
```
    Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
    
    Returns:
    
    Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
  - snapshotDatabaseTime
```
public final Instant snapshotDatabaseTime()
```
    The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
    
    If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
    
    Returns:
    
    The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
    
    If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
  - snapshotTarget
```
public final String snapshotTarget()
```
    Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
    
    Returns:
    
    Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
  - toBuilder
```
public DBSnapshot.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DBSnapshot.Builder,DBSnapshot>
  - builder
```
public static DBSnapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBSnapshot.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

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

hasProcessorFeatures

processorFeatures

dbiResourceId

hasTagList

tagList

originalSnapshotCreateTime

snapshotDatabaseTime

snapshotTarget

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields