DBSnapshot (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rds.model.DBSnapshot

All Implemented Interfaces:

Serializable
```
public class DBSnapshot
extends Object
implements Serializable
```
Contains the result of a successful invocation of the following actions:
- CreateDBSnapshot
- DeleteDBSnapshot
This data type is used as a response element in the DescribeDBSnapshots action.
See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

DBSnapshot()

Constructors
Constructor and Description
`DBSnapshot()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Integer`	`getAllocatedStorage()` Specifies the allocated storage size in gigabytes (GB).
`String`	`getAvailabilityZone()` Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
`String`	`getDBInstanceIdentifier()` Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
`String`	`getDBSnapshotIdentifier()` Specifies the identifier for the DB Snapshot.
`String`	`getEngine()` Specifies the name of the database engine.
`String`	`getEngineVersion()` Specifies the version of the database engine.
`Date`	`getInstanceCreateTime()` Specifies the time (UTC) when the snapshot was taken.
`Integer`	`getIops()` Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
`String`	`getLicenseModel()` License model information for the restored DB Instance.
`String`	`getMasterUsername()` Provides the master username for the DB Snapshot.
`String`	`getOptionGroupName()` Provides the option group name for the DB Snapshot.
`Integer`	`getPort()` Specifies the port that the database engine was listening on at the time of the snapshot.
`Date`	`getSnapshotCreateTime()` Provides the time (UTC) when the snapshot was taken.
`String`	`getSnapshotType()` Provides the type of the DB Snapshot.
`String`	`getStatus()` Specifies the status of this DB Snapshot.
`String`	`getVpcId()` Provides the Vpc Id associated with the DB Snapshot.
`int`	`hashCode()`
`void`	`setAllocatedStorage(Integer allocatedStorage)` Specifies the allocated storage size in gigabytes (GB).
`void`	`setAvailabilityZone(String availabilityZone)` Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
`void`	`setDBInstanceIdentifier(String dBInstanceIdentifier)` Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
`void`	`setDBSnapshotIdentifier(String dBSnapshotIdentifier)` Specifies the identifier for the DB Snapshot.
`void`	`setEngine(String engine)` Specifies the name of the database engine.
`void`	`setEngineVersion(String engineVersion)` Specifies the version of the database engine.
`void`	`setInstanceCreateTime(Date instanceCreateTime)` Specifies the time (UTC) when the snapshot was taken.
`void`	`setIops(Integer iops)` Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
`void`	`setLicenseModel(String licenseModel)` License model information for the restored DB Instance.
`void`	`setMasterUsername(String masterUsername)` Provides the master username for the DB Snapshot.
`void`	`setOptionGroupName(String optionGroupName)` Provides the option group name for the DB Snapshot.
`void`	`setPort(Integer port)` Specifies the port that the database engine was listening on at the time of the snapshot.
`void`	`setSnapshotCreateTime(Date snapshotCreateTime)` Provides the time (UTC) when the snapshot was taken.
`void`	`setSnapshotType(String snapshotType)` Provides the type of the DB Snapshot.
`void`	`setStatus(String status)` Specifies the status of this DB Snapshot.
`void`	`setVpcId(String vpcId)` Provides the Vpc Id associated with the DB Snapshot.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DBSnapshot`	`withAllocatedStorage(Integer allocatedStorage)` Specifies the allocated storage size in gigabytes (GB).
`DBSnapshot`	`withAvailabilityZone(String availabilityZone)` Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
`DBSnapshot`	`withDBInstanceIdentifier(String dBInstanceIdentifier)` Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
`DBSnapshot`	`withDBSnapshotIdentifier(String dBSnapshotIdentifier)` Specifies the identifier for the DB Snapshot.
`DBSnapshot`	`withEngine(String engine)` Specifies the name of the database engine.
`DBSnapshot`	`withEngineVersion(String engineVersion)` Specifies the version of the database engine.
`DBSnapshot`	`withInstanceCreateTime(Date instanceCreateTime)` Specifies the time (UTC) when the snapshot was taken.
`DBSnapshot`	`withIops(Integer iops)` Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
`DBSnapshot`	`withLicenseModel(String licenseModel)` License model information for the restored DB Instance.
`DBSnapshot`	`withMasterUsername(String masterUsername)` Provides the master username for the DB Snapshot.
`DBSnapshot`	`withOptionGroupName(String optionGroupName)` Provides the option group name for the DB Snapshot.
`DBSnapshot`	`withPort(Integer port)` Specifies the port that the database engine was listening on at the time of the snapshot.
`DBSnapshot`	`withSnapshotCreateTime(Date snapshotCreateTime)` Provides the time (UTC) when the snapshot was taken.
`DBSnapshot`	`withSnapshotType(String snapshotType)` Provides the type of the DB Snapshot.
`DBSnapshot`	`withStatus(String status)` Specifies the status of this DB Snapshot.
`DBSnapshot`	`withVpcId(String vpcId)` Provides the Vpc Id associated with the DB Snapshot.

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

- Constructor Detail
  - DBSnapshot
```
public DBSnapshot()
```
- Method Detail
  - getDBSnapshotIdentifier
```
public String getDBSnapshotIdentifier()
```
    Specifies the identifier for the DB Snapshot.
    
    Returns:
    Specifies the identifier for the DB Snapshot.
  - setDBSnapshotIdentifier
```
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
```
    Specifies the identifier for the DB Snapshot.
    
    Parameters:
    dBSnapshotIdentifier - Specifies the identifier for the DB Snapshot.
  - withDBSnapshotIdentifier
```
public DBSnapshot withDBSnapshotIdentifier(String dBSnapshotIdentifier)
```
    Specifies the identifier for the DB Snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    dBSnapshotIdentifier - Specifies the identifier for the DB Snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDBInstanceIdentifier
```
public String getDBInstanceIdentifier()
```
    Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
    
    Returns:
    Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
  - setDBInstanceIdentifier
```
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
```
    Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
    
    Parameters:
    dBInstanceIdentifier - Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
  - withDBInstanceIdentifier
```
public DBSnapshot withDBInstanceIdentifier(String dBInstanceIdentifier)
```
    Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    dBInstanceIdentifier - Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSnapshotCreateTime
```
public Date getSnapshotCreateTime()
```
    Provides the time (UTC) when the snapshot was taken.
    
    Returns:
    Provides the time (UTC) when the snapshot was taken.
  - setSnapshotCreateTime
```
public void setSnapshotCreateTime(Date snapshotCreateTime)
```
    Provides the time (UTC) when the snapshot was taken.
    
    Parameters:
    snapshotCreateTime - Provides the time (UTC) when the snapshot was taken.
  - withSnapshotCreateTime
```
public DBSnapshot withSnapshotCreateTime(Date snapshotCreateTime)
```
    Provides the time (UTC) when the snapshot was taken.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    snapshotCreateTime - Provides the time (UTC) when the snapshot was taken.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEngine
```
public String getEngine()
```
    Specifies the name of the database engine.
    
    Returns:
    Specifies the name of the database engine.
  - setEngine
```
public void setEngine(String engine)
```
    Specifies the name of the database engine.
    
    Parameters:
    engine - Specifies the name of the database engine.
  - withEngine
```
public DBSnapshot withEngine(String engine)
```
    Specifies the name of the database engine.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    engine - Specifies the name of the database engine.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAllocatedStorage
```
public Integer getAllocatedStorage()
```
    Specifies the allocated storage size in gigabytes (GB).
    
    Returns:
    Specifies the allocated storage size in gigabytes (GB).
  - setAllocatedStorage
```
public void setAllocatedStorage(Integer allocatedStorage)
```
    Specifies the allocated storage size in gigabytes (GB).
    
    Parameters:
    allocatedStorage - Specifies the allocated storage size in gigabytes (GB).
  - withAllocatedStorage
```
public DBSnapshot withAllocatedStorage(Integer allocatedStorage)
```
    Specifies the allocated storage size in gigabytes (GB).
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    allocatedStorage - Specifies the allocated storage size in gigabytes (GB).
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getStatus
```
public String getStatus()
```
    Specifies the status of this DB Snapshot.
    
    Returns:
    Specifies the status of this DB Snapshot.
  - setStatus
```
public void setStatus(String status)
```
    Specifies the status of this DB Snapshot.
    
    Parameters:
    status - Specifies the status of this DB Snapshot.
  - withStatus
```
public DBSnapshot withStatus(String status)
```
    Specifies the status of this DB Snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    status - Specifies the status of this DB Snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPort
```
public Integer getPort()
```
    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.
  - setPort
```
public void setPort(Integer port)
```
    Specifies the port that the database engine was listening on at the time of the snapshot.
    
    Parameters:
    port - Specifies the port that the database engine was listening on at the time of the snapshot.
  - withPort
```
public DBSnapshot withPort(Integer port)
```
    Specifies the port that the database engine was listening on at the time of the snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    port - Specifies the port that the database engine was listening on at the time of the snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    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.
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
    
    Parameters:
    availabilityZone - Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
  - withAvailabilityZone
```
public DBSnapshot withAvailabilityZone(String availabilityZone)
```
    Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    availabilityZone - Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getVpcId
```
public String getVpcId()
```
    Provides the Vpc Id associated with the DB Snapshot.
    
    Returns:
    Provides the Vpc Id associated with the DB Snapshot.
  - setVpcId
```
public void setVpcId(String vpcId)
```
    Provides the Vpc Id associated with the DB Snapshot.
    
    Parameters:
    vpcId - Provides the Vpc Id associated with the DB Snapshot.
  - withVpcId
```
public DBSnapshot withVpcId(String vpcId)
```
    Provides the Vpc Id associated with the DB Snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    vpcId - Provides the Vpc Id associated with the DB Snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getInstanceCreateTime
```
public Date getInstanceCreateTime()
```
    Specifies the time (UTC) when the snapshot was taken.
    
    Returns:
    Specifies the time (UTC) when the snapshot was taken.
  - setInstanceCreateTime
```
public void setInstanceCreateTime(Date instanceCreateTime)
```
    Specifies the time (UTC) when the snapshot was taken.
    
    Parameters:
    instanceCreateTime - Specifies the time (UTC) when the snapshot was taken.
  - withInstanceCreateTime
```
public DBSnapshot withInstanceCreateTime(Date instanceCreateTime)
```
    Specifies the time (UTC) when the snapshot was taken.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    instanceCreateTime - Specifies the time (UTC) when the snapshot was taken.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMasterUsername
```
public String getMasterUsername()
```
    Provides the master username for the DB Snapshot.
    
    Returns:
    Provides the master username for the DB Snapshot.
  - setMasterUsername
```
public void setMasterUsername(String masterUsername)
```
    Provides the master username for the DB Snapshot.
    
    Parameters:
    masterUsername - Provides the master username for the DB Snapshot.
  - withMasterUsername
```
public DBSnapshot withMasterUsername(String masterUsername)
```
    Provides the master username for the DB Snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    masterUsername - Provides the master username for the DB Snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEngineVersion
```
public String getEngineVersion()
```
    Specifies the version of the database engine.
    
    Returns:
    Specifies the version of the database engine.
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    Specifies the version of the database engine.
    
    Parameters:
    engineVersion - Specifies the version of the database engine.
  - withEngineVersion
```
public DBSnapshot withEngineVersion(String engineVersion)
```
    Specifies the version of the database engine.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    engineVersion - Specifies the version of the database engine.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getLicenseModel
```
public String getLicenseModel()
```
    License model information for the restored DB Instance.
    
    Returns:
    License model information for the restored DB Instance.
  - setLicenseModel
```
public void setLicenseModel(String licenseModel)
```
    License model information for the restored DB Instance.
    
    Parameters:
    licenseModel - License model information for the restored DB Instance.
  - withLicenseModel
```
public DBSnapshot withLicenseModel(String licenseModel)
```
    License model information for the restored DB Instance.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    licenseModel - License model information for the restored DB Instance.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSnapshotType
```
public String getSnapshotType()
```
    Provides the type of the DB Snapshot.
    
    Returns:
    Provides the type of the DB Snapshot.
  - setSnapshotType
```
public void setSnapshotType(String snapshotType)
```
    Provides the type of the DB Snapshot.
    
    Parameters:
    snapshotType - Provides the type of the DB Snapshot.
  - withSnapshotType
```
public DBSnapshot withSnapshotType(String snapshotType)
```
    Provides the type of the DB Snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    snapshotType - Provides the type of the DB Snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getIops
```
public Integer getIops()
```
    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.
  - setIops
```
public void setIops(Integer iops)
```
    Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
    
    Parameters:
    iops - Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
  - withIops
```
public DBSnapshot withIops(Integer iops)
```
    Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    iops - Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getOptionGroupName
```
public String getOptionGroupName()
```
    Provides the option group name for the DB Snapshot.
    
    Returns:
    Provides the option group name for the DB Snapshot.
  - setOptionGroupName
```
public void setOptionGroupName(String optionGroupName)
```
    Provides the option group name for the DB Snapshot.
    
    Parameters:
    optionGroupName - Provides the option group name for the DB Snapshot.
  - withOptionGroupName
```
public DBSnapshot withOptionGroupName(String optionGroupName)
```
    Provides the option group name for the DB Snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    optionGroupName - Provides the option group name for the DB Snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DBSnapshot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DBSnapshot

Method Detail

getDBSnapshotIdentifier

setDBSnapshotIdentifier

withDBSnapshotIdentifier

getDBInstanceIdentifier

setDBInstanceIdentifier

withDBInstanceIdentifier

getSnapshotCreateTime

setSnapshotCreateTime

withSnapshotCreateTime

getEngine

setEngine

withEngine

getAllocatedStorage

setAllocatedStorage

withAllocatedStorage

getStatus

setStatus

withStatus

getPort

setPort

withPort

getAvailabilityZone

setAvailabilityZone

withAvailabilityZone

getVpcId

setVpcId

withVpcId

getInstanceCreateTime

setInstanceCreateTime

withInstanceCreateTime

getMasterUsername

setMasterUsername

withMasterUsername

getEngineVersion

setEngineVersion

withEngineVersion

getLicenseModel

setLicenseModel

withLicenseModel

getSnapshotType

setSnapshotType

withSnapshotType

getIops

setIops

withIops

getOptionGroupName

setOptionGroupName

withOptionGroupName

toString

hashCode

equals