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.
Constructor and Description |
---|
DBSnapshot() |
Modifier and Type | Method and Description |
---|---|
DBSnapshot |
clone() |
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 DB instance identifier of the DB instance this DB
snapshot was created from.
|
String |
getDBSnapshotIdentifier()
Specifies the identifier for the DB snapshot.
|
Boolean |
getEncrypted()
Specifies whether the DB snapshot is encrypted.
|
String |
getEngine()
Specifies the name of the database engine.
|
String |
getEngineVersion()
Specifies the version of the database engine.
|
Date |
getInstanceCreateTime()
Specifies the time when the snapshot was taken, in Universal
Coordinated Time (UTC).
|
Integer |
getIops()
Specifies the Provisioned IOPS (I/O operations per second) value of
the DB instance at the time of the snapshot.
|
String |
getKmsKeyId()
If
Encrypted is true, the KMS key identifier for the
encrypted DB 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 |
getPercentProgress()
The percentage of the estimated data that has been transferred.
|
Integer |
getPort()
Specifies the port that the database engine was listening on at the
time of the snapshot.
|
Date |
getSnapshotCreateTime()
Provides the time when the snapshot was taken, in Universal
Coordinated Time (UTC).
|
String |
getSnapshotType()
Provides the type of the DB snapshot.
|
String |
getSourceDBSnapshotIdentifier()
The DB snapshot Arn that the DB snapshot was copied from.
|
String |
getSourceRegion()
The region that the DB snapshot was created in or copied from.
|
String |
getStatus()
Specifies the status of this DB snapshot.
|
String |
getStorageType()
Specifies the storage type associated with DB Snapshot.
|
String |
getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for
TDE encryption.
|
String |
getVpcId()
Provides the VPC ID associated with the DB snapshot.
|
int |
hashCode() |
Boolean |
isEncrypted()
Specifies whether the DB snapshot is encrypted.
|
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 DB instance identifier of the DB instance this DB
snapshot was created from.
|
void |
setDBSnapshotIdentifier(String dBSnapshotIdentifier)
Specifies the identifier for the DB snapshot.
|
void |
setEncrypted(Boolean encrypted)
Specifies whether the DB snapshot is encrypted.
|
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 when the snapshot was taken, in Universal
Coordinated Time (UTC).
|
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 |
setKmsKeyId(String kmsKeyId)
If
Encrypted is true, the KMS key identifier for the
encrypted DB 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 |
setPercentProgress(Integer percentProgress)
The percentage of the estimated data that has been transferred.
|
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 when the snapshot was taken, in Universal
Coordinated Time (UTC).
|
void |
setSnapshotType(String snapshotType)
Provides the type of the DB snapshot.
|
void |
setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)
The DB snapshot Arn that the DB snapshot was copied from.
|
void |
setSourceRegion(String sourceRegion)
The region that the DB snapshot was created in or copied from.
|
void |
setStatus(String status)
Specifies the status of this DB snapshot.
|
void |
setStorageType(String storageType)
Specifies the storage type associated with DB Snapshot.
|
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for
TDE encryption.
|
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 DB instance identifier of the DB instance this DB
snapshot was created from.
|
DBSnapshot |
withDBSnapshotIdentifier(String dBSnapshotIdentifier)
Specifies the identifier for the DB snapshot.
|
DBSnapshot |
withEncrypted(Boolean encrypted)
Specifies whether the DB snapshot is encrypted.
|
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 when the snapshot was taken, in Universal
Coordinated Time (UTC).
|
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 |
withKmsKeyId(String kmsKeyId)
If
Encrypted is true, the KMS key identifier for the
encrypted DB 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 |
withPercentProgress(Integer percentProgress)
The percentage of the estimated data that has been transferred.
|
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 when the snapshot was taken, in Universal
Coordinated Time (UTC).
|
DBSnapshot |
withSnapshotType(String snapshotType)
Provides the type of the DB snapshot.
|
DBSnapshot |
withSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)
The DB snapshot Arn that the DB snapshot was copied from.
|
DBSnapshot |
withSourceRegion(String sourceRegion)
The region that the DB snapshot was created in or copied from.
|
DBSnapshot |
withStatus(String status)
Specifies the status of this DB snapshot.
|
DBSnapshot |
withStorageType(String storageType)
Specifies the storage type associated with DB Snapshot.
|
DBSnapshot |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for
TDE encryption.
|
DBSnapshot |
withVpcId(String vpcId)
Provides the VPC ID associated with the DB snapshot.
|
public String getDBSnapshotIdentifier()
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
dBSnapshotIdentifier
- Specifies the identifier for the DB snapshot.public DBSnapshot withDBSnapshotIdentifier(String dBSnapshotIdentifier)
Returns a reference to this object so that method calls can be chained together.
dBSnapshotIdentifier
- Specifies the identifier for the DB snapshot.public String getDBInstanceIdentifier()
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
dBInstanceIdentifier
- Specifies the DB instance identifier of the DB instance this DB
snapshot was created from.public DBSnapshot withDBInstanceIdentifier(String dBInstanceIdentifier)
Returns a reference to this object so that method calls can be chained together.
dBInstanceIdentifier
- Specifies the DB instance identifier of the DB instance this DB
snapshot was created from.public Date getSnapshotCreateTime()
public void setSnapshotCreateTime(Date snapshotCreateTime)
snapshotCreateTime
- Provides the time when the snapshot was taken, in Universal
Coordinated Time (UTC).public DBSnapshot withSnapshotCreateTime(Date snapshotCreateTime)
Returns a reference to this object so that method calls can be chained together.
snapshotCreateTime
- Provides the time when the snapshot was taken, in Universal
Coordinated Time (UTC).public String getEngine()
public void setEngine(String engine)
engine
- Specifies the name of the database engine.public DBSnapshot withEngine(String engine)
Returns a reference to this object so that method calls can be chained together.
engine
- Specifies the name of the database engine.public Integer getAllocatedStorage()
public void setAllocatedStorage(Integer allocatedStorage)
allocatedStorage
- Specifies the allocated storage size in gigabytes (GB).public DBSnapshot withAllocatedStorage(Integer allocatedStorage)
Returns a reference to this object so that method calls can be chained together.
allocatedStorage
- Specifies the allocated storage size in gigabytes (GB).public String getStatus()
public void setStatus(String status)
status
- Specifies the status of this DB snapshot.public DBSnapshot withStatus(String status)
Returns a reference to this object so that method calls can be chained together.
status
- Specifies the status of this DB snapshot.public Integer getPort()
public void setPort(Integer port)
port
- Specifies the port that the database engine was listening on at the
time of the snapshot.public DBSnapshot withPort(Integer port)
Returns a reference to this object so that method calls can be chained together.
port
- Specifies the port that the database engine was listening on at the
time of the snapshot.public String getAvailabilityZone()
public void setAvailabilityZone(String availabilityZone)
availabilityZone
- Specifies the name of the Availability Zone the DB instance was
located in at the time of the DB snapshot.public DBSnapshot withAvailabilityZone(String availabilityZone)
Returns a reference to this object so that method calls can be chained together.
availabilityZone
- Specifies the name of the Availability Zone the DB instance was
located in at the time of the DB snapshot.public String getVpcId()
public void setVpcId(String vpcId)
vpcId
- Provides the VPC ID associated with the DB snapshot.public DBSnapshot withVpcId(String vpcId)
Returns a reference to this object so that method calls can be chained together.
vpcId
- Provides the VPC ID associated with the DB snapshot.public Date getInstanceCreateTime()
public void setInstanceCreateTime(Date instanceCreateTime)
instanceCreateTime
- Specifies the time when the snapshot was taken, in Universal
Coordinated Time (UTC).public DBSnapshot withInstanceCreateTime(Date instanceCreateTime)
Returns a reference to this object so that method calls can be chained together.
instanceCreateTime
- Specifies the time when the snapshot was taken, in Universal
Coordinated Time (UTC).public String getMasterUsername()
public void setMasterUsername(String masterUsername)
masterUsername
- Provides the master username for the DB snapshot.public DBSnapshot withMasterUsername(String masterUsername)
Returns a reference to this object so that method calls can be chained together.
masterUsername
- Provides the master username for the DB snapshot.public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- Specifies the version of the database engine.public DBSnapshot withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- Specifies the version of the database engine.public String getLicenseModel()
public void setLicenseModel(String licenseModel)
licenseModel
- License model information for the restored DB instance.public DBSnapshot withLicenseModel(String licenseModel)
Returns a reference to this object so that method calls can be chained together.
licenseModel
- License model information for the restored DB instance.public String getSnapshotType()
public void setSnapshotType(String snapshotType)
snapshotType
- Provides the type of the DB snapshot.public DBSnapshot withSnapshotType(String snapshotType)
Returns a reference to this object so that method calls can be chained together.
snapshotType
- Provides the type of the DB snapshot.public Integer getIops()
public void setIops(Integer iops)
iops
- Specifies the Provisioned IOPS (I/O operations per second) value of
the DB instance at the time of the snapshot.public DBSnapshot withIops(Integer iops)
Returns a reference to this object so that method calls can be chained together.
iops
- Specifies the Provisioned IOPS (I/O operations per second) value of
the DB instance at the time of the snapshot.public String getOptionGroupName()
public void setOptionGroupName(String optionGroupName)
optionGroupName
- Provides the option group name for the DB snapshot.public DBSnapshot withOptionGroupName(String optionGroupName)
Returns a reference to this object so that method calls can be chained together.
optionGroupName
- Provides the option group name for the DB snapshot.public Integer getPercentProgress()
public void setPercentProgress(Integer percentProgress)
percentProgress
- The percentage of the estimated data that has been transferred.public DBSnapshot withPercentProgress(Integer percentProgress)
Returns a reference to this object so that method calls can be chained together.
percentProgress
- The percentage of the estimated data that has been transferred.public String getSourceRegion()
public void setSourceRegion(String sourceRegion)
sourceRegion
- The region that the DB snapshot was created in or copied from.public DBSnapshot withSourceRegion(String sourceRegion)
Returns a reference to this object so that method calls can be chained together.
sourceRegion
- The region that the DB snapshot was created in or copied from.public String getSourceDBSnapshotIdentifier()
public void setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)
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.public DBSnapshot withSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)
Returns a reference to this object so that method calls can be chained together.
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.public String getStorageType()
public void setStorageType(String storageType)
storageType
- Specifies the storage type associated with DB Snapshot.public DBSnapshot withStorageType(String storageType)
Returns a reference to this object so that method calls can be chained together.
storageType
- Specifies the storage type associated with DB Snapshot.public String getTdeCredentialArn()
public void setTdeCredentialArn(String tdeCredentialArn)
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for
TDE encryption.public DBSnapshot withTdeCredentialArn(String tdeCredentialArn)
Returns a reference to this object so that method calls can be chained together.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for
TDE encryption.public Boolean isEncrypted()
public void setEncrypted(Boolean encrypted)
encrypted
- Specifies whether the DB snapshot is encrypted.public DBSnapshot withEncrypted(Boolean encrypted)
Returns a reference to this object so that method calls can be chained together.
encrypted
- Specifies whether the DB snapshot is encrypted.public Boolean getEncrypted()
public String getKmsKeyId()
Encrypted
is true, the KMS key identifier for the
encrypted DB snapshot.Encrypted
is true, the KMS key identifier for the
encrypted DB snapshot.public void setKmsKeyId(String kmsKeyId)
Encrypted
is true, the KMS key identifier for the
encrypted DB snapshot.kmsKeyId
- If Encrypted
is true, the KMS key identifier for the
encrypted DB snapshot.public DBSnapshot withKmsKeyId(String kmsKeyId)
Encrypted
is true, the KMS key identifier for the
encrypted DB snapshot.
Returns a reference to this object so that method calls can be chained together.
kmsKeyId
- If Encrypted
is true, the KMS key identifier for the
encrypted DB snapshot.public String toString()
toString
in class Object
Object.toString()
public DBSnapshot clone()
Copyright © 2015. All rights reserved.