Class DBSnapshot

java.lang.Object
com.amazonaws.services.rds.model.DBSnapshot
All Implemented Interfaces:
Serializable, Cloneable

public class DBSnapshot extends Object implements Serializable, Cloneable

Contains the result of a successful invocation of the following actions:

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

See Also:
  • Constructor Details

    • DBSnapshot

      public DBSnapshot()
  • Method Details

    • setDBSnapshotIdentifier

      public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)

      Specifies the identifier for the DB snapshot.

      Parameters:
      dBSnapshotIdentifier - Specifies the identifier for the DB snapshot.
    • getDBSnapshotIdentifier

      public String getDBSnapshotIdentifier()

      Specifies the identifier for the DB snapshot.

      Returns:
      Specifies the identifier for the DB snapshot.
    • withDBSnapshotIdentifier

      public DBSnapshot withDBSnapshotIdentifier(String dBSnapshotIdentifier)

      Specifies the identifier for the DB snapshot.

      Parameters:
      dBSnapshotIdentifier - Specifies the identifier for the DB snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDBInstanceIdentifier

      public void setDBInstanceIdentifier(String dBInstanceIdentifier)

      Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

      Parameters:
      dBInstanceIdentifier - Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
    • getDBInstanceIdentifier

      public String getDBInstanceIdentifier()

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

      public DBSnapshot withDBInstanceIdentifier(String dBInstanceIdentifier)

      Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

      Parameters:
      dBInstanceIdentifier - Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSnapshotCreateTime

      public void setSnapshotCreateTime(Date snapshotCreateTime)

      Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

      Parameters:
      snapshotCreateTime - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
    • getSnapshotCreateTime

      public Date getSnapshotCreateTime()

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

      public DBSnapshot withSnapshotCreateTime(Date snapshotCreateTime)

      Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

      Parameters:
      snapshotCreateTime - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEngine

      public void setEngine(String engine)

      Specifies the name of the database engine.

      Parameters:
      engine - Specifies the name of the database engine.
    • getEngine

      public String getEngine()

      Specifies the name of the database engine.

      Returns:
      Specifies the name of the database engine.
    • withEngine

      public DBSnapshot withEngine(String engine)

      Specifies the name of the database engine.

      Parameters:
      engine - Specifies the name of the database engine.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAllocatedStorage

      public void setAllocatedStorage(Integer allocatedStorage)

      Specifies the allocated storage size in gigabytes (GB).

      Parameters:
      allocatedStorage - Specifies the allocated storage size in gigabytes (GB).
    • getAllocatedStorage

      public Integer getAllocatedStorage()

      Specifies the allocated storage size in gigabytes (GB).

      Returns:
      Specifies the allocated storage size in gigabytes (GB).
    • withAllocatedStorage

      public DBSnapshot withAllocatedStorage(Integer allocatedStorage)

      Specifies the allocated storage size in gigabytes (GB).

      Parameters:
      allocatedStorage - Specifies the allocated storage size in gigabytes (GB).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStatus

      public void setStatus(String status)

      Specifies the status of this DB snapshot.

      Parameters:
      status - Specifies the status of this DB snapshot.
    • getStatus

      public String getStatus()

      Specifies the status of this DB snapshot.

      Returns:
      Specifies the status of this DB snapshot.
    • withStatus

      public DBSnapshot withStatus(String status)

      Specifies the status of this DB snapshot.

      Parameters:
      status - Specifies the status of this DB snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • withPort

      public DBSnapshot withPort(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • 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.

      Parameters:
      availabilityZone - Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • getVpcId

      public String getVpcId()

      Provides the VPC ID associated with the DB snapshot.

      Returns:
      Provides the VPC ID associated with the DB snapshot.
    • withVpcId

      public DBSnapshot withVpcId(String vpcId)

      Provides the VPC ID associated with the DB snapshot.

      Parameters:
      vpcId - Provides the VPC ID associated with the DB snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setInstanceCreateTime

      public void setInstanceCreateTime(Date instanceCreateTime)

      Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

      Parameters:
      instanceCreateTime - Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
    • getInstanceCreateTime

      public Date getInstanceCreateTime()

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

      public DBSnapshot withInstanceCreateTime(Date instanceCreateTime)

      Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

      Parameters:
      instanceCreateTime - Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMasterUsername

      public void setMasterUsername(String masterUsername)

      Provides the master username for the DB snapshot.

      Parameters:
      masterUsername - Provides the master username for the DB snapshot.
    • getMasterUsername

      public String getMasterUsername()

      Provides the master username for the DB snapshot.

      Returns:
      Provides the master username for the DB snapshot.
    • withMasterUsername

      public DBSnapshot withMasterUsername(String masterUsername)

      Provides the master username for the DB snapshot.

      Parameters:
      masterUsername - Provides the master username for the DB snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEngineVersion

      public void setEngineVersion(String engineVersion)

      Specifies the version of the database engine.

      Parameters:
      engineVersion - Specifies the version of the database engine.
    • getEngineVersion

      public String getEngineVersion()

      Specifies the version of the database engine.

      Returns:
      Specifies the version of the database engine.
    • withEngineVersion

      public DBSnapshot withEngineVersion(String engineVersion)

      Specifies the version of the database engine.

      Parameters:
      engineVersion - Specifies the version of the database engine.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLicenseModel

      public void setLicenseModel(String licenseModel)

      License model information for the restored DB instance.

      Parameters:
      licenseModel - License model information for the restored DB instance.
    • getLicenseModel

      public String getLicenseModel()

      License model information for the restored DB instance.

      Returns:
      License model information for the restored DB instance.
    • withLicenseModel

      public DBSnapshot withLicenseModel(String licenseModel)

      License model information for the restored DB instance.

      Parameters:
      licenseModel - License model information for the restored DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSnapshotType

      public void setSnapshotType(String snapshotType)

      Provides the type of the DB snapshot.

      Parameters:
      snapshotType - Provides the type of the DB snapshot.
    • getSnapshotType

      public String getSnapshotType()

      Provides the type of the DB snapshot.

      Returns:
      Provides the type of the DB snapshot.
    • withSnapshotType

      public DBSnapshot withSnapshotType(String snapshotType)

      Provides the type of the DB snapshot.

      Parameters:
      snapshotType - Provides the type of the DB snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • 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.

      Parameters:
      iops - Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • getOptionGroupName

      public String getOptionGroupName()

      Provides the option group name for the DB snapshot.

      Returns:
      Provides the option group name for the DB snapshot.
    • withOptionGroupName

      public DBSnapshot withOptionGroupName(String optionGroupName)

      Provides the option group name for the DB snapshot.

      Parameters:
      optionGroupName - Provides the option group name for the DB snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setPercentProgress

      public void setPercentProgress(Integer percentProgress)

      The percentage of the estimated data that has been transferred.

      Parameters:
      percentProgress - The percentage of the estimated data that has been transferred.
    • getPercentProgress

      public Integer getPercentProgress()

      The percentage of the estimated data that has been transferred.

      Returns:
      The percentage of the estimated data that has been transferred.
    • withPercentProgress

      public DBSnapshot withPercentProgress(Integer percentProgress)

      The percentage of the estimated data that has been transferred.

      Parameters:
      percentProgress - The percentage of the estimated data that has been transferred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSourceRegion

      public void setSourceRegion(String sourceRegion)

      The region that the DB snapshot was created in or copied from.

      Parameters:
      sourceRegion - The region that the DB snapshot was created in or copied from.
    • getSourceRegion

      public String getSourceRegion()

      The region that the DB snapshot was created in or copied from.

      Returns:
      The region that the DB snapshot was created in or copied from.
    • withSourceRegion

      public DBSnapshot withSourceRegion(String sourceRegion)

      The region that the DB snapshot was created in or copied from.

      Parameters:
      sourceRegion - The region that the DB snapshot was created in or copied from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSourceDBSnapshotIdentifier

      public void setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)

      The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

      Parameters:
      sourceDBSnapshotIdentifier - The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
    • getSourceDBSnapshotIdentifier

      public String getSourceDBSnapshotIdentifier()

      The DB snapshot 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 Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
    • withSourceDBSnapshotIdentifier

      public DBSnapshot withSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)

      The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

      Parameters:
      sourceDBSnapshotIdentifier - The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStorageType

      public void setStorageType(String storageType)

      Specifies the storage type associated with DB Snapshot.

      Parameters:
      storageType - Specifies the storage type associated with DB Snapshot.
    • getStorageType

      public String getStorageType()

      Specifies the storage type associated with DB Snapshot.

      Returns:
      Specifies the storage type associated with DB Snapshot.
    • withStorageType

      public DBSnapshot withStorageType(String storageType)

      Specifies the storage type associated with DB Snapshot.

      Parameters:
      storageType - Specifies the storage type associated with DB Snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setTdeCredentialArn

      public void setTdeCredentialArn(String tdeCredentialArn)

      The ARN from the Key Store with which to associate the instance for TDE encryption.

      Parameters:
      tdeCredentialArn - The ARN from the Key Store with which to associate the instance for TDE encryption.
    • getTdeCredentialArn

      public String getTdeCredentialArn()

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

      public DBSnapshot withTdeCredentialArn(String tdeCredentialArn)

      The ARN from the Key Store with which to associate the instance for TDE encryption.

      Parameters:
      tdeCredentialArn - The ARN from the Key Store with which to associate the instance for TDE encryption.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEncrypted

      public void setEncrypted(Boolean encrypted)

      Specifies whether the DB snapshot is encrypted.

      Parameters:
      encrypted - Specifies whether the DB snapshot is encrypted.
    • getEncrypted

      public Boolean getEncrypted()

      Specifies whether the DB snapshot is encrypted.

      Returns:
      Specifies whether the DB snapshot is encrypted.
    • withEncrypted

      public DBSnapshot withEncrypted(Boolean encrypted)

      Specifies whether the DB snapshot is encrypted.

      Parameters:
      encrypted - Specifies whether the DB snapshot is encrypted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isEncrypted

      public Boolean isEncrypted()

      Specifies whether the DB snapshot is encrypted.

      Returns:
      Specifies whether the DB snapshot is encrypted.
    • setKmsKeyId

      public void setKmsKeyId(String kmsKeyId)

      If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

      Parameters:
      kmsKeyId - If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
    • getKmsKeyId

      public String getKmsKeyId()

      If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

      Returns:
      If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
    • withKmsKeyId

      public DBSnapshot withKmsKeyId(String kmsKeyId)

      If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

      Parameters:
      kmsKeyId - If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
      Returns:
      Returns a reference to this 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DBSnapshot clone()
      Overrides:
      clone in class Object