@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBClusterSnapshot extends Object implements Serializable, Cloneable
Detailed information about a cluster snapshot.
Constructor and Description |
---|
DBClusterSnapshot() |
Modifier and Type | Method and Description |
---|---|
DBClusterSnapshot |
clone() |
boolean |
equals(Object obj) |
List<String> |
getAvailabilityZones()
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
|
Date |
getClusterCreateTime()
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
|
String |
getDBClusterIdentifier()
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
|
String |
getDBClusterSnapshotArn()
The Amazon Resource Name (ARN) for the cluster snapshot.
|
String |
getDBClusterSnapshotIdentifier()
Specifies the identifier for the cluster snapshot.
|
String |
getEngine()
Specifies the name of the database engine.
|
String |
getEngineVersion()
Provides the version of the database engine for this cluster snapshot.
|
String |
getKmsKeyId()
If
StorageEncrypted is true , the KMS key identifier for the encrypted cluster snapshot. |
String |
getMasterUsername()
Provides the master user name for the cluster snapshot.
|
Integer |
getPercentProgress()
Specifies the percentage of the estimated data that has been transferred.
|
Integer |
getPort()
Specifies the port that the cluster was listening on at the time of the snapshot.
|
Date |
getSnapshotCreateTime()
Provides the time when the snapshot was taken, in UTC.
|
String |
getSnapshotType()
Provides the type of the cluster snapshot.
|
String |
getSourceDBClusterSnapshotArn()
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot;
otherwise, a null value.
|
String |
getStatus()
Specifies the status of this cluster snapshot.
|
Boolean |
getStorageEncrypted()
Specifies whether the cluster snapshot is encrypted.
|
String |
getStorageType()
Storage type associated with your cluster snapshot
|
String |
getVpcId()
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
|
int |
hashCode() |
Boolean |
isStorageEncrypted()
Specifies whether the cluster snapshot is encrypted.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
|
void |
setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
|
void |
setDBClusterSnapshotArn(String dBClusterSnapshotArn)
The Amazon Resource Name (ARN) for the cluster snapshot.
|
void |
setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the 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 cluster snapshot.
|
void |
setKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true , the KMS key identifier for the encrypted cluster snapshot. |
void |
setMasterUsername(String masterUsername)
Provides the master user name for the 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 cluster was listening on at the time of the snapshot.
|
void |
setSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in UTC.
|
void |
setSnapshotType(String snapshotType)
Provides the type of the cluster snapshot.
|
void |
setSourceDBClusterSnapshotArn(String sourceDBClusterSnapshotArn)
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot;
otherwise, a null value.
|
void |
setStatus(String status)
Specifies the status of this cluster snapshot.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the cluster snapshot is encrypted.
|
void |
setStorageType(String storageType)
Storage type associated with your cluster snapshot
|
void |
setVpcId(String vpcId)
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
|
String |
toString()
Returns a string representation of this object.
|
DBClusterSnapshot |
withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
|
DBClusterSnapshot |
withAvailabilityZones(String... availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
|
DBClusterSnapshot |
withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
|
DBClusterSnapshot |
withDBClusterIdentifier(String dBClusterIdentifier)
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
|
DBClusterSnapshot |
withDBClusterSnapshotArn(String dBClusterSnapshotArn)
The Amazon Resource Name (ARN) for the cluster snapshot.
|
DBClusterSnapshot |
withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the 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 cluster snapshot.
|
DBClusterSnapshot |
withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true , the KMS key identifier for the encrypted cluster snapshot. |
DBClusterSnapshot |
withMasterUsername(String masterUsername)
Provides the master user name for the 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 cluster was listening on at the time of the snapshot.
|
DBClusterSnapshot |
withSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in UTC.
|
DBClusterSnapshot |
withSnapshotType(String snapshotType)
Provides the type of the cluster snapshot.
|
DBClusterSnapshot |
withSourceDBClusterSnapshotArn(String sourceDBClusterSnapshotArn)
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot;
otherwise, a null value.
|
DBClusterSnapshot |
withStatus(String status)
Specifies the status of this cluster snapshot.
|
DBClusterSnapshot |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the cluster snapshot is encrypted.
|
DBClusterSnapshot |
withStorageType(String storageType)
Storage type associated with your cluster snapshot
|
DBClusterSnapshot |
withVpcId(String vpcId)
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
|
public List<String> getAvailabilityZones()
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
public void setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored
in.public DBClusterSnapshot withAvailabilityZones(String... availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
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 Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored
in.public DBClusterSnapshot withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored
in.public void setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the cluster snapshot.
dBClusterSnapshotIdentifier
- Specifies the identifier for the cluster snapshot.public String getDBClusterSnapshotIdentifier()
Specifies the identifier for the cluster snapshot.
public DBClusterSnapshot withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
Specifies the identifier for the cluster snapshot.
dBClusterSnapshotIdentifier
- Specifies the identifier for the cluster snapshot.public void setDBClusterIdentifier(String dBClusterIdentifier)
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
dBClusterIdentifier
- Specifies the cluster identifier of the cluster that this cluster snapshot was created from.public String getDBClusterIdentifier()
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
public DBClusterSnapshot withDBClusterIdentifier(String dBClusterIdentifier)
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
dBClusterIdentifier
- Specifies the cluster identifier of the cluster that this cluster snapshot was created from.public void setSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in UTC.
snapshotCreateTime
- Provides the time when the snapshot was taken, in UTC.public Date getSnapshotCreateTime()
Provides the time when the snapshot was taken, in UTC.
public DBClusterSnapshot withSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in UTC.
snapshotCreateTime
- Provides the time when the snapshot was taken, in 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 setStatus(String status)
Specifies the status of this cluster snapshot.
status
- Specifies the status of this cluster snapshot.public String getStatus()
Specifies the status of this cluster snapshot.
public DBClusterSnapshot withStatus(String status)
Specifies the status of this cluster snapshot.
status
- Specifies the status of this cluster snapshot.public void setPort(Integer port)
Specifies the port that the cluster was listening on at the time of the snapshot.
port
- Specifies the port that the cluster was listening on at the time of the snapshot.public Integer getPort()
Specifies the port that the cluster was listening on at the time of the snapshot.
public DBClusterSnapshot withPort(Integer port)
Specifies the port that the cluster was listening on at the time of the snapshot.
port
- Specifies the port that the cluster was listening on at the time of the snapshot.public void setVpcId(String vpcId)
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
vpcId
- Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.public String getVpcId()
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
public DBClusterSnapshot withVpcId(String vpcId)
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
vpcId
- Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.public void setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).public Date getClusterCreateTime()
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
public DBClusterSnapshot withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).public void setMasterUsername(String masterUsername)
Provides the master user name for the cluster snapshot.
masterUsername
- Provides the master user name for the cluster snapshot.public String getMasterUsername()
Provides the master user name for the cluster snapshot.
public DBClusterSnapshot withMasterUsername(String masterUsername)
Provides the master user name for the cluster snapshot.
masterUsername
- Provides the master user name for the cluster snapshot.public void setEngineVersion(String engineVersion)
Provides the version of the database engine for this cluster snapshot.
engineVersion
- Provides the version of the database engine for this cluster snapshot.public String getEngineVersion()
Provides the version of the database engine for this cluster snapshot.
public DBClusterSnapshot withEngineVersion(String engineVersion)
Provides the version of the database engine for this cluster snapshot.
engineVersion
- Provides the version of the database engine for this cluster snapshot.public void setSnapshotType(String snapshotType)
Provides the type of the cluster snapshot.
snapshotType
- Provides the type of the cluster snapshot.public String getSnapshotType()
Provides the type of the cluster snapshot.
public DBClusterSnapshot withSnapshotType(String snapshotType)
Provides the type of the cluster snapshot.
snapshotType
- Provides the type of the 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 cluster snapshot is encrypted.
storageEncrypted
- Specifies whether the cluster snapshot is encrypted.public Boolean getStorageEncrypted()
Specifies whether the cluster snapshot is encrypted.
public DBClusterSnapshot withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the cluster snapshot is encrypted.
storageEncrypted
- Specifies whether the cluster snapshot is encrypted.public Boolean isStorageEncrypted()
Specifies whether the cluster snapshot is encrypted.
public void setKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster snapshot.
kmsKeyId
- If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster
snapshot.public String getKmsKeyId()
If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster snapshot.
StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster
snapshot.public DBClusterSnapshot withKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster snapshot.
kmsKeyId
- If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster
snapshot.public void setDBClusterSnapshotArn(String dBClusterSnapshotArn)
The Amazon Resource Name (ARN) for the cluster snapshot.
dBClusterSnapshotArn
- The Amazon Resource Name (ARN) for the cluster snapshot.public String getDBClusterSnapshotArn()
The Amazon Resource Name (ARN) for the cluster snapshot.
public DBClusterSnapshot withDBClusterSnapshotArn(String dBClusterSnapshotArn)
The Amazon Resource Name (ARN) for the cluster snapshot.
dBClusterSnapshotArn
- The Amazon Resource Name (ARN) for the cluster snapshot.public void setSourceDBClusterSnapshotArn(String sourceDBClusterSnapshotArn)
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
sourceDBClusterSnapshotArn
- If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster
snapshot; otherwise, a null value.public String getSourceDBClusterSnapshotArn()
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
public DBClusterSnapshot withSourceDBClusterSnapshotArn(String sourceDBClusterSnapshotArn)
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
sourceDBClusterSnapshotArn
- If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster
snapshot; otherwise, a null value.public void setStorageType(String storageType)
Storage type associated with your cluster snapshot
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
storageType
- Storage type associated with your cluster snapshot
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
public String getStorageType()
Storage type associated with your cluster snapshot
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
public DBClusterSnapshot withStorageType(String storageType)
Storage type associated with your cluster snapshot
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
storageType
- Storage type associated with your cluster snapshot
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
public String toString()
toString
in class Object
Object.toString()
public DBClusterSnapshot clone()