Class DBSnapshot
- All Implemented Interfaces:
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Specifies the allocated storage size in gigabytes (GB).Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.Specifies the DB instance identifier of the DB instance this DB snapshot was created from.Specifies the identifier for the DB snapshot.Specifies whether the DB snapshot is encrypted.Specifies the name of the database engine.Specifies the version of the database engine.Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).getIops()
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.IfEncrypted
is true, the KMS key identifier for the encrypted DB snapshot.License model information for the restored DB instance.Provides the master username for the DB snapshot.Provides the option group name for the DB snapshot.The percentage of the estimated data that has been transferred.getPort()
Specifies the port that the database engine was listening on at the time of the snapshot.Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).Provides the type of the DB snapshot.The DB snapshot Arn that the DB snapshot was copied from.The region that the DB snapshot was created in or copied from.Specifies the status of this DB snapshot.Specifies the storage type associated with DB Snapshot.The ARN from the Key Store with which to associate the instance for TDE encryption.getVpcId()
Provides the VPC ID associated with the DB snapshot.int
hashCode()
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
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
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.void
setKmsKeyId
(String kmsKeyId) IfEncrypted
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
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
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
Provides the VPC ID associated with the DB snapshot.toString()
Returns a string representation of this object; useful for testing and debugging.withAllocatedStorage
(Integer allocatedStorage) Specifies the allocated storage size in gigabytes (GB).withAvailabilityZone
(String availabilityZone) Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.withDBInstanceIdentifier
(String dBInstanceIdentifier) Specifies the DB instance identifier of the DB instance this DB snapshot was created from.withDBSnapshotIdentifier
(String dBSnapshotIdentifier) Specifies the identifier for the DB snapshot.withEncrypted
(Boolean encrypted) Specifies whether the DB snapshot is encrypted.withEngine
(String engine) Specifies the name of the database engine.withEngineVersion
(String engineVersion) Specifies the version of the database engine.withInstanceCreateTime
(Date instanceCreateTime) Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.withKmsKeyId
(String kmsKeyId) IfEncrypted
is true, the KMS key identifier for the encrypted DB snapshot.withLicenseModel
(String licenseModel) License model information for the restored DB instance.withMasterUsername
(String masterUsername) Provides the master username for the DB snapshot.withOptionGroupName
(String optionGroupName) Provides the option group name for the DB snapshot.withPercentProgress
(Integer percentProgress) The percentage of the estimated data that has been transferred.Specifies the port that the database engine was listening on at the time of the snapshot.withSnapshotCreateTime
(Date snapshotCreateTime) Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).withSnapshotType
(String snapshotType) Provides the type of the DB snapshot.withSourceDBSnapshotIdentifier
(String sourceDBSnapshotIdentifier) The DB snapshot Arn that the DB snapshot was copied from.withSourceRegion
(String sourceRegion) The region that the DB snapshot was created in or copied from.withStatus
(String status) Specifies the status of this DB snapshot.withStorageType
(String storageType) Specifies the storage type associated with DB Snapshot.withTdeCredentialArn
(String tdeCredentialArn) The ARN from the Key Store with which to associate the instance for TDE encryption.Provides the VPC ID associated with the DB snapshot.
-
Constructor Details
-
DBSnapshot
public DBSnapshot()
-
-
Method Details
-
setDBSnapshotIdentifier
Specifies the identifier for the DB snapshot.
- Parameters:
dBSnapshotIdentifier
- Specifies the identifier for the DB snapshot.
-
getDBSnapshotIdentifier
Specifies the identifier for the DB snapshot.
- Returns:
- Specifies the identifier for the DB snapshot.
-
withDBSnapshotIdentifier
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
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
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
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
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
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
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
Specifies the name of the database engine.
- Parameters:
engine
- Specifies the name of the database engine.
-
getEngine
Specifies the name of the database engine.
- Returns:
- Specifies the name of the database engine.
-
withEngine
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
Specifies the allocated storage size in gigabytes (GB).
- Parameters:
allocatedStorage
- Specifies the allocated storage size in gigabytes (GB).
-
getAllocatedStorage
Specifies the allocated storage size in gigabytes (GB).
- Returns:
- Specifies the allocated storage size in gigabytes (GB).
-
withAllocatedStorage
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
Specifies the status of this DB snapshot.
- Parameters:
status
- Specifies the status of this DB snapshot.
-
getStatus
Specifies the status of this DB snapshot.
- Returns:
- Specifies the status of this DB snapshot.
-
withStatus
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
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
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
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
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
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
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
Provides the VPC ID associated with the DB snapshot.
- Parameters:
vpcId
- Provides the VPC ID associated with the DB snapshot.
-
getVpcId
Provides the VPC ID associated with the DB snapshot.
- Returns:
- Provides the VPC ID associated with the DB snapshot.
-
withVpcId
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
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
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
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
Provides the master username for the DB snapshot.
- Parameters:
masterUsername
- Provides the master username for the DB snapshot.
-
getMasterUsername
Provides the master username for the DB snapshot.
- Returns:
- Provides the master username for the DB snapshot.
-
withMasterUsername
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
Specifies the version of the database engine.
- Parameters:
engineVersion
- Specifies the version of the database engine.
-
getEngineVersion
Specifies the version of the database engine.
- Returns:
- Specifies the version of the database engine.
-
withEngineVersion
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
License model information for the restored DB instance.
- Parameters:
licenseModel
- License model information for the restored DB instance.
-
getLicenseModel
License model information for the restored DB instance.
- Returns:
- License model information for the restored DB instance.
-
withLicenseModel
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
Provides the type of the DB snapshot.
- Parameters:
snapshotType
- Provides the type of the DB snapshot.
-
getSnapshotType
Provides the type of the DB snapshot.
- Returns:
- Provides the type of the DB snapshot.
-
withSnapshotType
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
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
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
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
Provides the option group name for the DB snapshot.
- Parameters:
optionGroupName
- Provides the option group name for the DB snapshot.
-
getOptionGroupName
Provides the option group name for the DB snapshot.
- Returns:
- Provides the option group name for the DB snapshot.
-
withOptionGroupName
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
The percentage of the estimated data that has been transferred.
- Parameters:
percentProgress
- The percentage of the estimated data that has been transferred.
-
getPercentProgress
The percentage of the estimated data that has been transferred.
- Returns:
- The percentage of the estimated data that has been transferred.
-
withPercentProgress
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
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
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
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
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
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
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
Specifies the storage type associated with DB Snapshot.
- Parameters:
storageType
- Specifies the storage type associated with DB Snapshot.
-
getStorageType
Specifies the storage type associated with DB Snapshot.
- Returns:
- Specifies the storage type associated with DB Snapshot.
-
withStorageType
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
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
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
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
Specifies whether the DB snapshot is encrypted.
- Parameters:
encrypted
- Specifies whether the DB snapshot is encrypted.
-
getEncrypted
Specifies whether the DB snapshot is encrypted.
- Returns:
- Specifies whether the DB snapshot is encrypted.
-
withEncrypted
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
Specifies whether the DB snapshot is encrypted.
- Returns:
- Specifies whether the DB snapshot is encrypted.
-
setKmsKeyId
If
Encrypted
is true, the KMS key identifier for the encrypted DB snapshot.- Parameters:
kmsKeyId
- IfEncrypted
is true, the KMS key identifier for the encrypted DB snapshot.
-
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
If
Encrypted
is true, the KMS key identifier for the encrypted DB snapshot.- Parameters:
kmsKeyId
- IfEncrypted
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-