DBClusterSnapshot (AWS SDK for Java

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:
- CreateDBClusterSnapshot
- DeleteDBClusterSnapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DBClusterSnapshot()

Constructors
Constructor and Description
`DBClusterSnapshot()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DBClusterSnapshot`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getAllocatedStorage()` 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.
`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`	`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.
`String`	`getKmsKeyId()` If `StorageEncrypted` is true, the 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`	`getStatus()` Specifies the status of this DB cluster snapshot.
`Boolean`	`getStorageEncrypted()` Specifies whether the DB cluster snapshot is encrypted.
`String`	`getVpcId()` Provides the VPC ID associated with the DB cluster snapshot.
`int`	`hashCode()`
`Boolean`	`isStorageEncrypted()` Specifies whether the DB cluster snapshot is encrypted.
`void`	`setAllocatedStorage(Integer allocatedStorage)` Specifies the allocated storage size in gigabytes (GB).
`void`	`setAvailabilityZones(Collection<String> availabilityZones)` Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
`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`	`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`	`setKmsKeyId(String kmsKeyId)` If `StorageEncrypted` is true, the 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`	`setStatus(String status)` Specifies the status of this DB cluster snapshot.
`void`	`setStorageEncrypted(Boolean storageEncrypted)` Specifies whether the DB cluster snapshot is encrypted.
`void`	`setVpcId(String vpcId)` Provides the VPC ID associated with the DB cluster snapshot.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DBClusterSnapshot`	`withAllocatedStorage(Integer allocatedStorage)` Specifies the allocated storage size in gigabytes (GB).
`DBClusterSnapshot`	`withAvailabilityZones(Collection<String> availabilityZones)` Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
`DBClusterSnapshot`	`withAvailabilityZones(String... availabilityZones)` Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
`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`	`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`	`withKmsKeyId(String kmsKeyId)` If `StorageEncrypted` is true, the 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`	`withStatus(String status)` Specifies the status of this DB cluster snapshot.
`DBClusterSnapshot`	`withStorageEncrypted(Boolean storageEncrypted)` Specifies whether the DB cluster snapshot is encrypted.
`DBClusterSnapshot`	`withVpcId(String vpcId)` Provides the VPC ID associated with the DB cluster snapshot.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DBClusterSnapshot
```
public DBClusterSnapshot()
```
- 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) or withAvailabilityZones(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 StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.
    
    Returns:
    
    If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.
  - withKmsKeyId
```
public DBClusterSnapshot withKmsKeyId(String kmsKeyId)
```
    If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is 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:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DBClusterSnapshot clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DBClusterSnapshot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DBClusterSnapshot

Method Detail

getAvailabilityZones

setAvailabilityZones

withAvailabilityZones

withAvailabilityZones

setDBClusterSnapshotIdentifier

getDBClusterSnapshotIdentifier

withDBClusterSnapshotIdentifier

setDBClusterIdentifier

getDBClusterIdentifier

withDBClusterIdentifier

setSnapshotCreateTime

getSnapshotCreateTime

withSnapshotCreateTime

setEngine

getEngine

withEngine

setAllocatedStorage

getAllocatedStorage

withAllocatedStorage

setStatus

getStatus

withStatus

setPort

getPort

withPort

setVpcId

getVpcId

withVpcId

setClusterCreateTime

getClusterCreateTime

withClusterCreateTime

setMasterUsername

getMasterUsername

withMasterUsername

setEngineVersion

getEngineVersion

withEngineVersion

setLicenseModel

getLicenseModel

withLicenseModel

setSnapshotType

getSnapshotType

withSnapshotType

setPercentProgress

getPercentProgress

withPercentProgress

setStorageEncrypted

getStorageEncrypted

withStorageEncrypted

isStorageEncrypted

setKmsKeyId

getKmsKeyId

withKmsKeyId

toString

equals

hashCode

clone