@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBClusterSnapshot extends Object implements Serializable, Cloneable
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots
action.
Constructor and Description |
---|
DBClusterSnapshot() |
Modifier and Type | Method and Description |
---|---|
DBClusterSnapshot |
clone() |
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
Specifies the allocated storage size in gibibytes (GiB).
|
List<String> |
getAvailabilityZones()
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
|
Date |
getClusterCreateTime()
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
String |
getDBClusterIdentifier()
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
|
String |
getDBClusterSnapshotArn()
The Amazon Resource Name (ARN) for the DB cluster snapshot.
|
String |
getDBClusterSnapshotIdentifier()
Specifies the identifier for the DB cluster snapshot.
|
String |
getEngine()
Specifies the name of the database engine.
|
String |
getEngineVersion()
Provides the version of the database engine for this DB cluster snapshot.
|
Boolean |
getIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
otherwise false.
|
String |
getKmsKeyId()
If
StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. |
String |
getLicenseModel()
Provides the license model information for this DB cluster snapshot.
|
String |
getMasterUsername()
Provides the master username for the DB cluster snapshot.
|
Integer |
getPercentProgress()
Specifies the percentage of the estimated data that has been transferred.
|
Integer |
getPort()
Specifies the port that the DB cluster 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 cluster snapshot.
|
String |
getSourceDBClusterSnapshotArn()
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the
source DB cluster snapshot, otherwise, a null value.
|
String |
getStatus()
Specifies the status of this DB cluster snapshot.
|
Boolean |
getStorageEncrypted()
Specifies whether the DB cluster snapshot is encrypted.
|
List<Tag> |
getTagList() |
String |
getVpcId()
Provides the VPC ID associated with the DB cluster snapshot.
|
int |
hashCode() |
Boolean |
isIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
otherwise false.
|
Boolean |
isStorageEncrypted()
Specifies whether the DB cluster snapshot is encrypted.
|
void |
setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gibibytes (GiB).
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
|
void |
setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
|
void |
setDBClusterSnapshotArn(String dBClusterSnapshotArn)
The Amazon Resource Name (ARN) for the DB cluster snapshot.
|
void |
setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the DB cluster snapshot.
|
void |
setEngine(String engine)
Specifies the name of the database engine.
|
void |
setEngineVersion(String engineVersion)
Provides the version of the database engine for this DB cluster snapshot.
|
void |
setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
otherwise false.
|
void |
setKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. |
void |
setLicenseModel(String licenseModel)
Provides the license model information for this DB cluster snapshot.
|
void |
setMasterUsername(String masterUsername)
Provides the master username for the DB cluster snapshot.
|
void |
setPercentProgress(Integer percentProgress)
Specifies the percentage of the estimated data that has been transferred.
|
void |
setPort(Integer port)
Specifies the port that the DB cluster 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 cluster snapshot.
|
void |
setSourceDBClusterSnapshotArn(String sourceDBClusterSnapshotArn)
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the
source DB cluster snapshot, otherwise, a null value.
|
void |
setStatus(String status)
Specifies the status of this DB cluster snapshot.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster snapshot is encrypted.
|
void |
setTagList(Collection<Tag> tagList) |
void |
setVpcId(String vpcId)
Provides the VPC ID associated with the DB cluster snapshot.
|
String |
toString()
Returns a string representation of this object.
|
DBClusterSnapshot |
withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gibibytes (GiB).
|
DBClusterSnapshot |
withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
|
DBClusterSnapshot |
withAvailabilityZones(String... availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
|
DBClusterSnapshot |
withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
DBClusterSnapshot |
withDBClusterIdentifier(String dBClusterIdentifier)
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
|
DBClusterSnapshot |
withDBClusterSnapshotArn(String dBClusterSnapshotArn)
The Amazon Resource Name (ARN) for the DB cluster snapshot.
|
DBClusterSnapshot |
withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the DB cluster snapshot.
|
DBClusterSnapshot |
withEngine(String engine)
Specifies the name of the database engine.
|
DBClusterSnapshot |
withEngineVersion(String engineVersion)
Provides the version of the database engine for this DB cluster snapshot.
|
DBClusterSnapshot |
withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
otherwise false.
|
DBClusterSnapshot |
withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. |
DBClusterSnapshot |
withLicenseModel(String licenseModel)
Provides the license model information for this DB cluster snapshot.
|
DBClusterSnapshot |
withMasterUsername(String masterUsername)
Provides the master username for the DB cluster snapshot.
|
DBClusterSnapshot |
withPercentProgress(Integer percentProgress)
Specifies the percentage of the estimated data that has been transferred.
|
DBClusterSnapshot |
withPort(Integer port)
Specifies the port that the DB cluster was listening on at the time of the snapshot.
|
DBClusterSnapshot |
withSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
|
DBClusterSnapshot |
withSnapshotType(String snapshotType)
Provides the type of the DB cluster snapshot.
|
DBClusterSnapshot |
withSourceDBClusterSnapshotArn(String sourceDBClusterSnapshotArn)
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the
source DB cluster snapshot, otherwise, a null value.
|
DBClusterSnapshot |
withStatus(String status)
Specifies the status of this DB cluster snapshot.
|
DBClusterSnapshot |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster snapshot is encrypted.
|
DBClusterSnapshot |
withTagList(Collection<Tag> tagList) |
DBClusterSnapshot |
withTagList(Tag... tagList)
NOTE: This method appends the values to the existing list (if any).
|
DBClusterSnapshot |
withVpcId(String vpcId)
Provides the VPC ID associated with the DB cluster snapshot.
|
public List<String> getAvailabilityZones()
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
public void setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.public DBClusterSnapshot withAvailabilityZones(String... availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)
or withAvailabilityZones(java.util.Collection)
if
you want to override the existing values.
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.public DBClusterSnapshot withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.public void setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the DB cluster snapshot.
dBClusterSnapshotIdentifier
- Specifies the identifier for the DB cluster snapshot.public String getDBClusterSnapshotIdentifier()
Specifies the identifier for the DB cluster snapshot.
public DBClusterSnapshot withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the DB cluster snapshot.
dBClusterSnapshotIdentifier
- Specifies the identifier for the DB cluster snapshot.public void setDBClusterIdentifier(String dBClusterIdentifier)
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
dBClusterIdentifier
- Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.public String getDBClusterIdentifier()
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
public DBClusterSnapshot withDBClusterIdentifier(String dBClusterIdentifier)
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
dBClusterIdentifier
- Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.public void setSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
snapshotCreateTime
- Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).public Date getSnapshotCreateTime()
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
public DBClusterSnapshot withSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
snapshotCreateTime
- Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).public void setEngine(String engine)
Specifies the name of the database engine.
engine
- Specifies the name of the database engine.public String getEngine()
Specifies the name of the database engine.
public DBClusterSnapshot withEngine(String engine)
Specifies the name of the database engine.
engine
- Specifies the name of the database engine.public void setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gibibytes (GiB).
allocatedStorage
- Specifies the allocated storage size in gibibytes (GiB).public Integer getAllocatedStorage()
Specifies the allocated storage size in gibibytes (GiB).
public DBClusterSnapshot withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gibibytes (GiB).
allocatedStorage
- Specifies the allocated storage size in gibibytes (GiB).public void setStatus(String status)
Specifies the status of this DB cluster snapshot.
status
- Specifies the status of this DB cluster snapshot.public String getStatus()
Specifies the status of this DB cluster snapshot.
public DBClusterSnapshot withStatus(String status)
Specifies the status of this DB cluster snapshot.
status
- Specifies the status of this DB cluster snapshot.public void setPort(Integer port)
Specifies the port that the DB cluster was listening on at the time of the snapshot.
port
- Specifies the port that the DB cluster was listening on at the time of the snapshot.public Integer getPort()
Specifies the port that the DB cluster was listening on at the time of the snapshot.
public DBClusterSnapshot withPort(Integer port)
Specifies the port that the DB cluster was listening on at the time of the snapshot.
port
- Specifies the port that the DB cluster was listening on at the time of the snapshot.public void setVpcId(String vpcId)
Provides the VPC ID associated with the DB cluster snapshot.
vpcId
- Provides the VPC ID associated with the DB cluster snapshot.public String getVpcId()
Provides the VPC ID associated with the DB cluster snapshot.
public DBClusterSnapshot withVpcId(String vpcId)
Provides the VPC ID associated with the DB cluster snapshot.
vpcId
- Provides the VPC ID associated with the DB cluster snapshot.public void setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).public Date getClusterCreateTime()
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
public DBClusterSnapshot withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).public void setMasterUsername(String masterUsername)
Provides the master username for the DB cluster snapshot.
masterUsername
- Provides the master username for the DB cluster snapshot.public String getMasterUsername()
Provides the master username for the DB cluster snapshot.
public DBClusterSnapshot withMasterUsername(String masterUsername)
Provides the master username for the DB cluster snapshot.
masterUsername
- Provides the master username for the DB cluster snapshot.public void setEngineVersion(String engineVersion)
Provides the version of the database engine for this DB cluster snapshot.
engineVersion
- Provides the version of the database engine for this DB cluster snapshot.public String getEngineVersion()
Provides the version of the database engine for this DB cluster snapshot.
public DBClusterSnapshot withEngineVersion(String engineVersion)
Provides the version of the database engine for this DB cluster snapshot.
engineVersion
- Provides the version of the database engine for this DB cluster snapshot.public void setLicenseModel(String licenseModel)
Provides the license model information for this DB cluster snapshot.
licenseModel
- Provides the license model information for this DB cluster snapshot.public String getLicenseModel()
Provides the license model information for this DB cluster snapshot.
public DBClusterSnapshot withLicenseModel(String licenseModel)
Provides the license model information for this DB cluster snapshot.
licenseModel
- Provides the license model information for this DB cluster snapshot.public void setSnapshotType(String snapshotType)
Provides the type of the DB cluster snapshot.
snapshotType
- Provides the type of the DB cluster snapshot.public String getSnapshotType()
Provides the type of the DB cluster snapshot.
public DBClusterSnapshot withSnapshotType(String snapshotType)
Provides the type of the DB cluster snapshot.
snapshotType
- Provides the type of the DB cluster snapshot.public void setPercentProgress(Integer percentProgress)
Specifies the percentage of the estimated data that has been transferred.
percentProgress
- Specifies the percentage of the estimated data that has been transferred.public Integer getPercentProgress()
Specifies the percentage of the estimated data that has been transferred.
public DBClusterSnapshot withPercentProgress(Integer percentProgress)
Specifies the percentage of the estimated data that has been transferred.
percentProgress
- Specifies the percentage of the estimated data that has been transferred.public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster snapshot is encrypted.
storageEncrypted
- Specifies whether the DB cluster snapshot is encrypted.public Boolean getStorageEncrypted()
Specifies whether the DB cluster snapshot is encrypted.
public DBClusterSnapshot withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster snapshot is encrypted.
storageEncrypted
- Specifies whether the DB cluster snapshot is encrypted.public Boolean isStorageEncrypted()
Specifies whether the DB cluster snapshot is encrypted.
public void setKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
kmsKeyId
- If StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB cluster
snapshot.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
public String getKmsKeyId()
If StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB cluster
snapshot.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
public DBClusterSnapshot withKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
kmsKeyId
- If StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB cluster
snapshot.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
public void setDBClusterSnapshotArn(String dBClusterSnapshotArn)
The Amazon Resource Name (ARN) for the DB cluster snapshot.
dBClusterSnapshotArn
- The Amazon Resource Name (ARN) for the DB cluster snapshot.public String getDBClusterSnapshotArn()
The Amazon Resource Name (ARN) for the DB cluster snapshot.
public DBClusterSnapshot withDBClusterSnapshotArn(String dBClusterSnapshotArn)
The Amazon Resource Name (ARN) for the DB cluster snapshot.
dBClusterSnapshotArn
- The Amazon Resource Name (ARN) for the DB cluster snapshot.public void setSourceDBClusterSnapshotArn(String sourceDBClusterSnapshotArn)
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
sourceDBClusterSnapshotArn
- If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN)
for the source DB cluster snapshot, otherwise, a null value.public String getSourceDBClusterSnapshotArn()
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
public DBClusterSnapshot withSourceDBClusterSnapshotArn(String sourceDBClusterSnapshotArn)
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
sourceDBClusterSnapshotArn
- If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN)
for the source DB cluster snapshot, otherwise, a null value.public void setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
iAMDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
otherwise false.public Boolean getIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
public DBClusterSnapshot withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
iAMDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
otherwise false.public Boolean isIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
public void setTagList(Collection<Tag> tagList)
tagList
- public DBClusterSnapshot withTagList(Tag... tagList)
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
or withTagList(java.util.Collection)
if you want to override
the existing values.
tagList
- public DBClusterSnapshot withTagList(Collection<Tag> tagList)
tagList
- public String toString()
toString
in class Object
Object.toString()
public DBClusterSnapshot clone()