Class DBClusterSnapshot
- java.lang.Object
-
- com.amazonaws.services.rds.model.DBClusterSnapshot
-
- All Implemented Interfaces:
Serializable,Cloneable
public class DBClusterSnapshot 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 DescribeDBClusterSnapshots action.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DBClusterSnapshot()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DBClusterSnapshotclone()booleanequals(Object obj)IntegergetAllocatedStorage()Specifies the allocated storage size in gigabytes (GB).List<String>getAvailabilityZones()Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.DategetClusterCreateTime()Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).StringgetDBClusterIdentifier()Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.StringgetDBClusterSnapshotIdentifier()Specifies the identifier for the DB cluster snapshot.StringgetEngine()Specifies the name of the database engine.StringgetEngineVersion()Provides the version of the database engine for this DB cluster snapshot.StringgetKmsKeyId()IfStorageEncryptedis true, the KMS key identifier for the encrypted DB cluster snapshot.StringgetLicenseModel()Provides the license model information for this DB cluster snapshot.StringgetMasterUsername()Provides the master username for the DB cluster snapshot.IntegergetPercentProgress()Specifies the percentage of the estimated data that has been transferred.IntegergetPort()Specifies the port that the DB cluster was listening on at the time of the snapshot.DategetSnapshotCreateTime()Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).StringgetSnapshotType()Provides the type of the DB cluster snapshot.StringgetStatus()Specifies the status of this DB cluster snapshot.BooleangetStorageEncrypted()Specifies whether the DB cluster snapshot is encrypted.StringgetVpcId()Provides the VPC ID associated with the DB cluster snapshot.inthashCode()BooleanisStorageEncrypted()Specifies whether the DB cluster snapshot is encrypted.voidsetAllocatedStorage(Integer allocatedStorage)Specifies the allocated storage size in gigabytes (GB).voidsetAvailabilityZones(Collection<String> availabilityZones)Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.voidsetClusterCreateTime(Date clusterCreateTime)Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).voidsetDBClusterIdentifier(String dBClusterIdentifier)Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.voidsetDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)Specifies the identifier for the DB cluster snapshot.voidsetEngine(String engine)Specifies the name of the database engine.voidsetEngineVersion(String engineVersion)Provides the version of the database engine for this DB cluster snapshot.voidsetKmsKeyId(String kmsKeyId)IfStorageEncryptedis true, the KMS key identifier for the encrypted DB cluster snapshot.voidsetLicenseModel(String licenseModel)Provides the license model information for this DB cluster snapshot.voidsetMasterUsername(String masterUsername)Provides the master username for the DB cluster snapshot.voidsetPercentProgress(Integer percentProgress)Specifies the percentage of the estimated data that has been transferred.voidsetPort(Integer port)Specifies the port that the DB cluster was listening on at the time of the snapshot.voidsetSnapshotCreateTime(Date snapshotCreateTime)Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).voidsetSnapshotType(String snapshotType)Provides the type of the DB cluster snapshot.voidsetStatus(String status)Specifies the status of this DB cluster snapshot.voidsetStorageEncrypted(Boolean storageEncrypted)Specifies whether the DB cluster snapshot is encrypted.voidsetVpcId(String vpcId)Provides the VPC ID associated with the DB cluster snapshot.StringtoString()Returns a string representation of this object; useful for testing and debugging.DBClusterSnapshotwithAllocatedStorage(Integer allocatedStorage)Specifies the allocated storage size in gigabytes (GB).DBClusterSnapshotwithAvailabilityZones(String... availabilityZones)Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.DBClusterSnapshotwithAvailabilityZones(Collection<String> availabilityZones)Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.DBClusterSnapshotwithClusterCreateTime(Date clusterCreateTime)Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).DBClusterSnapshotwithDBClusterIdentifier(String dBClusterIdentifier)Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.DBClusterSnapshotwithDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)Specifies the identifier for the DB cluster snapshot.DBClusterSnapshotwithEngine(String engine)Specifies the name of the database engine.DBClusterSnapshotwithEngineVersion(String engineVersion)Provides the version of the database engine for this DB cluster snapshot.DBClusterSnapshotwithKmsKeyId(String kmsKeyId)IfStorageEncryptedis true, the KMS key identifier for the encrypted DB cluster snapshot.DBClusterSnapshotwithLicenseModel(String licenseModel)Provides the license model information for this DB cluster snapshot.DBClusterSnapshotwithMasterUsername(String masterUsername)Provides the master username for the DB cluster snapshot.DBClusterSnapshotwithPercentProgress(Integer percentProgress)Specifies the percentage of the estimated data that has been transferred.DBClusterSnapshotwithPort(Integer port)Specifies the port that the DB cluster was listening on at the time of the snapshot.DBClusterSnapshotwithSnapshotCreateTime(Date snapshotCreateTime)Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).DBClusterSnapshotwithSnapshotType(String snapshotType)Provides the type of the DB cluster snapshot.DBClusterSnapshotwithStatus(String status)Specifies the status of this DB cluster snapshot.DBClusterSnapshotwithStorageEncrypted(Boolean storageEncrypted)Specifies whether the DB cluster snapshot is encrypted.DBClusterSnapshotwithVpcId(String vpcId)Provides the VPC ID associated with the DB cluster snapshot.
-
-
-
Method Detail
-
getAvailabilityZones
public List<String> getAvailabilityZones()
Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
- Returns:
- Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
-
setAvailabilityZones
public void setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
- Parameters:
availabilityZones- Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
-
withAvailabilityZones
public DBClusterSnapshot withAvailabilityZones(String... availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)orwithAvailabilityZones(java.util.Collection)if you want to override the existing values.- Parameters:
availabilityZones- Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAvailabilityZones
public DBClusterSnapshot withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
- Parameters:
availabilityZones- Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBClusterSnapshotIdentifier
public void setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the DB cluster snapshot.
- Parameters:
dBClusterSnapshotIdentifier- Specifies the identifier for the DB cluster snapshot.
-
getDBClusterSnapshotIdentifier
public String getDBClusterSnapshotIdentifier()
Specifies the identifier for the DB cluster snapshot.
- Returns:
- Specifies the identifier for the DB cluster snapshot.
-
withDBClusterSnapshotIdentifier
public DBClusterSnapshot withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the DB cluster snapshot.
- Parameters:
dBClusterSnapshotIdentifier- Specifies the identifier for the DB cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBClusterIdentifier
public void setDBClusterIdentifier(String dBClusterIdentifier)
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
- Parameters:
dBClusterIdentifier- Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
-
getDBClusterIdentifier
public String getDBClusterIdentifier()
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
- Returns:
- Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
-
withDBClusterIdentifier
public DBClusterSnapshot withDBClusterIdentifier(String dBClusterIdentifier)
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
- Parameters:
dBClusterIdentifier- Specifies the DB cluster identifier of the DB cluster that this DB cluster 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 DBClusterSnapshot 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 DBClusterSnapshot 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 DBClusterSnapshot 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 cluster snapshot.
- Parameters:
status- Specifies the status of this DB cluster snapshot.
-
getStatus
public String getStatus()
Specifies the status of this DB cluster snapshot.
- Returns:
- Specifies the status of this DB cluster snapshot.
-
withStatus
public DBClusterSnapshot withStatus(String status)
Specifies the status of this DB cluster snapshot.
- Parameters:
status- Specifies the status of this DB cluster 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 DB cluster was listening on at the time of the snapshot.
- Parameters:
port- Specifies the port that the DB cluster was listening on at the time of the snapshot.
-
getPort
public Integer getPort()
Specifies the port that the DB cluster was listening on at the time of the snapshot.
- Returns:
- Specifies the port that the DB cluster was listening on at the time of the snapshot.
-
withPort
public DBClusterSnapshot withPort(Integer port)
Specifies the port that the DB cluster was listening on at the time of the snapshot.
- Parameters:
port- Specifies the port that the DB cluster was listening on at the time of the 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 cluster snapshot.
- Parameters:
vpcId- Provides the VPC ID associated with the DB cluster snapshot.
-
getVpcId
public String getVpcId()
Provides the VPC ID associated with the DB cluster snapshot.
- Returns:
- Provides the VPC ID associated with the DB cluster snapshot.
-
withVpcId
public DBClusterSnapshot withVpcId(String vpcId)
Provides the VPC ID associated with the DB cluster snapshot.
- Parameters:
vpcId- Provides the VPC ID associated with the DB cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClusterCreateTime
public void setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
- Parameters:
clusterCreateTime- Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
-
getClusterCreateTime
public Date getClusterCreateTime()
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
- Returns:
- Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
-
withClusterCreateTime
public DBClusterSnapshot withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
- Parameters:
clusterCreateTime- Specifies the time when the DB cluster was created, 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 cluster snapshot.
- Parameters:
masterUsername- Provides the master username for the DB cluster snapshot.
-
getMasterUsername
public String getMasterUsername()
Provides the master username for the DB cluster snapshot.
- Returns:
- Provides the master username for the DB cluster snapshot.
-
withMasterUsername
public DBClusterSnapshot withMasterUsername(String masterUsername)
Provides the master username for the DB cluster snapshot.
- Parameters:
masterUsername- Provides the master username for the DB cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngineVersion
public void setEngineVersion(String engineVersion)
Provides the version of the database engine for this DB cluster snapshot.
- Parameters:
engineVersion- Provides the version of the database engine for this DB cluster snapshot.
-
getEngineVersion
public String getEngineVersion()
Provides the version of the database engine for this DB cluster snapshot.
- Returns:
- Provides the version of the database engine for this DB cluster snapshot.
-
withEngineVersion
public DBClusterSnapshot withEngineVersion(String engineVersion)
Provides the version of the database engine for this DB cluster snapshot.
- Parameters:
engineVersion- Provides the version of the database engine for this DB cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLicenseModel
public void setLicenseModel(String licenseModel)
Provides the license model information for this DB cluster snapshot.
- Parameters:
licenseModel- Provides the license model information for this DB cluster snapshot.
-
getLicenseModel
public String getLicenseModel()
Provides the license model information for this DB cluster snapshot.
- Returns:
- Provides the license model information for this DB cluster snapshot.
-
withLicenseModel
public DBClusterSnapshot withLicenseModel(String licenseModel)
Provides the license model information for this DB cluster snapshot.
- Parameters:
licenseModel- Provides the license model information for this DB cluster snapshot.- 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 cluster snapshot.
- Parameters:
snapshotType- Provides the type of the DB cluster snapshot.
-
getSnapshotType
public String getSnapshotType()
Provides the type of the DB cluster snapshot.
- Returns:
- Provides the type of the DB cluster snapshot.
-
withSnapshotType
public DBClusterSnapshot withSnapshotType(String snapshotType)
Provides the type of the DB cluster snapshot.
- Parameters:
snapshotType- Provides the type of the DB cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPercentProgress
public void setPercentProgress(Integer percentProgress)
Specifies the percentage of the estimated data that has been transferred.
- Parameters:
percentProgress- Specifies the percentage of the estimated data that has been transferred.
-
getPercentProgress
public Integer getPercentProgress()
Specifies the percentage of the estimated data that has been transferred.
- Returns:
- Specifies the percentage of the estimated data that has been transferred.
-
withPercentProgress
public DBClusterSnapshot withPercentProgress(Integer percentProgress)
Specifies the percentage of the estimated data that has been transferred.
- Parameters:
percentProgress- Specifies 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.
-
setStorageEncrypted
public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster snapshot is encrypted.
- Parameters:
storageEncrypted- Specifies whether the DB cluster snapshot is encrypted.
-
getStorageEncrypted
public Boolean getStorageEncrypted()
Specifies whether the DB cluster snapshot is encrypted.
- Returns:
- Specifies whether the DB cluster snapshot is encrypted.
-
withStorageEncrypted
public DBClusterSnapshot withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster snapshot is encrypted.
- Parameters:
storageEncrypted- Specifies whether the DB cluster snapshot is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isStorageEncrypted
public Boolean isStorageEncrypted()
Specifies whether the DB cluster snapshot is encrypted.
- Returns:
- Specifies whether the DB cluster snapshot is encrypted.
-
setKmsKeyId
public void setKmsKeyId(String kmsKeyId)
If
StorageEncryptedis true, the KMS key identifier for the encrypted DB cluster snapshot.- Parameters:
kmsKeyId- IfStorageEncryptedis true, the KMS key identifier for the encrypted DB cluster snapshot.
-
getKmsKeyId
public String getKmsKeyId()
If
StorageEncryptedis true, the KMS key identifier for the encrypted DB cluster snapshot.- Returns:
- If
StorageEncryptedis true, the KMS key identifier for the encrypted DB cluster snapshot.
-
withKmsKeyId
public DBClusterSnapshot withKmsKeyId(String kmsKeyId)
If
StorageEncryptedis true, the KMS key identifier for the encrypted DB cluster snapshot.- Parameters:
kmsKeyId- IfStorageEncryptedis true, the KMS key identifier for the encrypted DB cluster 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:
toStringin classObject- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DBClusterSnapshot clone()
-
-