DBClusterSnapshot (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.rds.model

Class DBClusterSnapshot

java.lang.Object
- com.amazonaws.services.rds.model.DBClusterSnapshot

All Implemented Interfaces:

Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DBClusterSnapshot ()

Constructors
Constructor and Description
`DBClusterSnapshot ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`DBClusterSnapshot`	`clone ()`
`boolean`	`equals (Object obj)`
`Integer`	`getAllocatedStorage ()` The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
`List<String>`	`getAvailabilityZones ()` The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
`Date`	`getClusterCreateTime ()` The time when the DB cluster was created, in Universal Coordinated Time (UTC).
`String`	`getDBClusterIdentifier ()` The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
`String`	`getDbClusterResourceId ()` The resource ID 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 ()` The identifier for the DB cluster snapshot.
`String`	`getDBSystemId ()` Reserved for future use.
`String`	`getEngine ()` The name of the database engine for this DB cluster snapshot.
`String`	`getEngineMode ()` The engine mode of the database engine for this DB cluster snapshot.
`String`	`getEngineVersion ()` The version of the database engine for this DB cluster snapshot.
`Boolean`	`getIAMDatabaseAuthenticationEnabled ()` Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
`String`	`getKmsKeyId ()` If `StorageEncrypted` is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
`String`	`getLicenseModel ()` The license model information for this DB cluster snapshot.
`String`	`getMasterUsername ()` The master username for this DB cluster snapshot.
`Integer`	`getPercentProgress ()` The percentage of the estimated data that has been transferred.
`Integer`	`getPort ()` The port that the DB cluster was listening on at the time of the snapshot.
`Date`	`getSnapshotCreateTime ()` The time when the snapshot was taken, in Universal Coordinated Time (UTC).
`String`	`getSnapshotType ()` 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 ()` The status of this DB cluster snapshot.
`Boolean`	`getStorageEncrypted ()` Indicates whether the DB cluster snapshot is encrypted.
`Integer`	`getStorageThroughput ()` The storage throughput for the DB cluster snapshot.
`String`	`getStorageType ()` The storage type associated with the DB cluster snapshot.
`List<Tag>`	`getTagList ()`
`String`	`getVpcId ()` The VPC ID associated with the DB cluster snapshot.
`int`	`hashCode ()`
`Boolean`	`isIAMDatabaseAuthenticationEnabled ()` Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
`Boolean`	`isStorageEncrypted ()` Indicates whether the DB cluster snapshot is encrypted.
`void`	`setAllocatedStorage (Integer allocatedStorage)` The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
`void`	`setAvailabilityZones (Collection<String> availabilityZones)` The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
`void`	`setClusterCreateTime (Date clusterCreateTime)` The time when the DB cluster was created, in Universal Coordinated Time (UTC).
`void`	`setDBClusterIdentifier (String dBClusterIdentifier)` The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
`void`	`setDbClusterResourceId (String dbClusterResourceId)` The resource ID 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)` The identifier for the DB cluster snapshot.
`void`	`setDBSystemId (String dBSystemId)` Reserved for future use.
`void`	`setEngine (String engine)` The name of the database engine for this DB cluster snapshot.
`void`	`setEngineMode (String engineMode)` The engine mode of the database engine for this DB cluster snapshot.
`void`	`setEngineVersion (String engineVersion)` The version of the database engine for this DB cluster snapshot.
`void`	`setIAMDatabaseAuthenticationEnabled (Boolean iAMDatabaseAuthenticationEnabled)` Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
`void`	`setKmsKeyId (String kmsKeyId)` If `StorageEncrypted` is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
`void`	`setLicenseModel (String licenseModel)` The license model information for this DB cluster snapshot.
`void`	`setMasterUsername (String masterUsername)` The master username for this DB cluster snapshot.
`void`	`setPercentProgress (Integer percentProgress)` The percentage of the estimated data that has been transferred.
`void`	`setPort (Integer port)` The port that the DB cluster was listening on at the time of the snapshot.
`void`	`setSnapshotCreateTime (Date snapshotCreateTime)` The time when the snapshot was taken, in Universal Coordinated Time (UTC).
`void`	`setSnapshotType (String snapshotType)` 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)` The status of this DB cluster snapshot.
`void`	`setStorageEncrypted (Boolean storageEncrypted)` Indicates whether the DB cluster snapshot is encrypted.
`void`	`setStorageThroughput (Integer storageThroughput)` The storage throughput for the DB cluster snapshot.
`void`	`setStorageType (String storageType)` The storage type associated with the DB cluster snapshot.
`void`	`setTagList (Collection<Tag> tagList)`
`void`	`setVpcId (String vpcId)` The VPC ID associated with the DB cluster snapshot.
`String`	`toString ()` Returns a string representation of this object.
`DBClusterSnapshot`	`withAllocatedStorage (Integer allocatedStorage)` The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
`DBClusterSnapshot`	`withAvailabilityZones (Collection<String> availabilityZones)` The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
`DBClusterSnapshot`	`withAvailabilityZones (String... availabilityZones)` The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
`DBClusterSnapshot`	`withClusterCreateTime (Date clusterCreateTime)` The time when the DB cluster was created, in Universal Coordinated Time (UTC).
`DBClusterSnapshot`	`withDBClusterIdentifier (String dBClusterIdentifier)` The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
`DBClusterSnapshot`	`withDbClusterResourceId (String dbClusterResourceId)` The resource ID 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)` The identifier for the DB cluster snapshot.
`DBClusterSnapshot`	`withDBSystemId (String dBSystemId)` Reserved for future use.
`DBClusterSnapshot`	`withEngine (String engine)` The name of the database engine for this DB cluster snapshot.
`DBClusterSnapshot`	`withEngineMode (String engineMode)` The engine mode of the database engine for this DB cluster snapshot.
`DBClusterSnapshot`	`withEngineVersion (String engineVersion)` The version of the database engine for this DB cluster snapshot.
`DBClusterSnapshot`	`withIAMDatabaseAuthenticationEnabled (Boolean iAMDatabaseAuthenticationEnabled)` Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
`DBClusterSnapshot`	`withKmsKeyId (String kmsKeyId)` If `StorageEncrypted` is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
`DBClusterSnapshot`	`withLicenseModel (String licenseModel)` The license model information for this DB cluster snapshot.
`DBClusterSnapshot`	`withMasterUsername (String masterUsername)` The master username for this DB cluster snapshot.
`DBClusterSnapshot`	`withPercentProgress (Integer percentProgress)` The percentage of the estimated data that has been transferred.
`DBClusterSnapshot`	`withPort (Integer port)` The port that the DB cluster was listening on at the time of the snapshot.
`DBClusterSnapshot`	`withSnapshotCreateTime (Date snapshotCreateTime)` The time when the snapshot was taken, in Universal Coordinated Time (UTC).
`DBClusterSnapshot`	`withSnapshotType (String snapshotType)` 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)` The status of this DB cluster snapshot.
`DBClusterSnapshot`	`withStorageEncrypted (Boolean storageEncrypted)` Indicates whether the DB cluster snapshot is encrypted.
`DBClusterSnapshot`	`withStorageThroughput (Integer storageThroughput)` The storage throughput for the DB cluster snapshot.
`DBClusterSnapshot`	`withStorageType (String storageType)` The storage type associated with the DB cluster snapshot.
`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)` 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()
```
    The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    
    Returns:
    
    The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
  - setAvailabilityZones
```
public void setAvailabilityZones(Collection<String> availabilityZones)
```
    The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    
    Parameters:
    
    availabilityZones - The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
  - withAvailabilityZones
```
public DBClusterSnapshot withAvailabilityZones(String... availabilityZones)
```
    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.
    
    Parameters:
    
    availabilityZones - The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAvailabilityZones
```
public DBClusterSnapshot withAvailabilityZones(Collection<String> availabilityZones)
```
    The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    
    Parameters:
    
    availabilityZones - The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterSnapshotIdentifier
```
public void setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
```
    The identifier for the DB cluster snapshot.
    
    Parameters:
    
    dBClusterSnapshotIdentifier - The identifier for the DB cluster snapshot.
  - getDBClusterSnapshotIdentifier
```
public String getDBClusterSnapshotIdentifier()
```
    The identifier for the DB cluster snapshot.
    
    Returns:
    
    The identifier for the DB cluster snapshot.
  - withDBClusterSnapshotIdentifier
```
public DBClusterSnapshot withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
```
    The identifier for the DB cluster snapshot.
    
    Parameters:
    
    dBClusterSnapshotIdentifier - 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)
```
    The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
    
    Parameters:
    
    dBClusterIdentifier - The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
  - getDBClusterIdentifier
```
public String getDBClusterIdentifier()
```
    The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
    
    Returns:
    
    The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
  - withDBClusterIdentifier
```
public DBClusterSnapshot withDBClusterIdentifier(String dBClusterIdentifier)
```
    The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
    
    Parameters:
    
    dBClusterIdentifier - 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)
```
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    
    Parameters:
    
    snapshotCreateTime - The time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - getSnapshotCreateTime
```
public Date getSnapshotCreateTime()
```
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - withSnapshotCreateTime
```
public DBClusterSnapshot withSnapshotCreateTime(Date snapshotCreateTime)
```
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    
    Parameters:
    
    snapshotCreateTime - 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)
```
    The name of the database engine for this DB cluster snapshot.
    
    Parameters:
    
    engine - The name of the database engine for this DB cluster snapshot.
  - getEngine
```
public String getEngine()
```
    The name of the database engine for this DB cluster snapshot.
    
    Returns:
    
    The name of the database engine for this DB cluster snapshot.
  - withEngine
```
public DBClusterSnapshot withEngine(String engine)
```
    The name of the database engine for this DB cluster snapshot.
    
    Parameters:
    
    engine - The name of the database engine for this DB cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineMode
```
public void setEngineMode(String engineMode)
```
    The engine mode of the database engine for this DB cluster snapshot.
    
    Parameters:
    
    engineMode - The engine mode of the database engine for this DB cluster snapshot.
  - getEngineMode
```
public String getEngineMode()
```
    The engine mode of the database engine for this DB cluster snapshot.
    
    Returns:
    
    The engine mode of the database engine for this DB cluster snapshot.
  - withEngineMode
```
public DBClusterSnapshot withEngineMode(String engineMode)
```
    The engine mode of the database engine for this DB cluster snapshot.
    
    Parameters:
    
    engineMode - The engine mode of the database engine for this DB cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllocatedStorage
```
public void setAllocatedStorage(Integer allocatedStorage)
```
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    
    Parameters:
    
    allocatedStorage - The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
  - getAllocatedStorage
```
public Integer getAllocatedStorage()
```
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    
    Returns:
    
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
  - withAllocatedStorage
```
public DBClusterSnapshot withAllocatedStorage(Integer allocatedStorage)
```
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    
    Parameters:
    
    allocatedStorage - The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of this DB cluster snapshot. Valid statuses are the following:
    - available
    - copying
    - creating
    Parameters:
    status - The status of this DB cluster snapshot. Valid statuses are the following:
    
    available
    
    copying
    
    creating
  - getStatus
```
public String getStatus()
```
    The status of this DB cluster snapshot. Valid statuses are the following:
    - available
    - copying
    - creating
    Returns:
    The status of this DB cluster snapshot. Valid statuses are the following:
    
    available
    
    copying
    
    creating
  - withStatus
```
public DBClusterSnapshot withStatus(String status)
```
    The status of this DB cluster snapshot. Valid statuses are the following:
    - available
    - copying
    - creating
    Parameters:
    status - The status of this DB cluster snapshot. Valid statuses are the following:
    
    available
    
    copying
    
    creating
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(Integer port)
```
    The port that the DB cluster was listening on at the time of the snapshot.
    
    Parameters:
    
    port - The port that the DB cluster was listening on at the time of the snapshot.
  - getPort
```
public Integer getPort()
```
    The port that the DB cluster was listening on at the time of the snapshot.
    
    Returns:
    
    The port that the DB cluster was listening on at the time of the snapshot.
  - withPort
```
public DBClusterSnapshot withPort(Integer port)
```
    The port that the DB cluster was listening on at the time of the snapshot.
    
    Parameters:
    
    port - 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)
```
    The VPC ID associated with the DB cluster snapshot.
    
    Parameters:
    
    vpcId - The VPC ID associated with the DB cluster snapshot.
  - getVpcId
```
public String getVpcId()
```
    The VPC ID associated with the DB cluster snapshot.
    
    Returns:
    
    The VPC ID associated with the DB cluster snapshot.
  - withVpcId
```
public DBClusterSnapshot withVpcId(String vpcId)
```
    The VPC ID associated with the DB cluster snapshot.
    
    Parameters:
    
    vpcId - 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)
```
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    
    Parameters:
    
    clusterCreateTime - The time when the DB cluster was created, in Universal Coordinated Time (UTC).
  - getClusterCreateTime
```
public Date getClusterCreateTime()
```
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
  - withClusterCreateTime
```
public DBClusterSnapshot withClusterCreateTime(Date clusterCreateTime)
```
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    
    Parameters:
    
    clusterCreateTime - 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)
```
    The master username for this DB cluster snapshot.
    
    Parameters:
    
    masterUsername - The master username for this DB cluster snapshot.
  - getMasterUsername
```
public String getMasterUsername()
```
    The master username for this DB cluster snapshot.
    
    Returns:
    
    The master username for this DB cluster snapshot.
  - withMasterUsername
```
public DBClusterSnapshot withMasterUsername(String masterUsername)
```
    The master username for this DB cluster snapshot.
    
    Parameters:
    
    masterUsername - The master username for this DB cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    The version of the database engine for this DB cluster snapshot.
    
    Parameters:
    
    engineVersion - The version of the database engine for this DB cluster snapshot.
  - getEngineVersion
```
public String getEngineVersion()
```
    The version of the database engine for this DB cluster snapshot.
    
    Returns:
    
    The version of the database engine for this DB cluster snapshot.
  - withEngineVersion
```
public DBClusterSnapshot withEngineVersion(String engineVersion)
```
    The version of the database engine for this DB cluster snapshot.
    
    Parameters:
    
    engineVersion - 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)
```
    The license model information for this DB cluster snapshot.
    
    Parameters:
    
    licenseModel - The license model information for this DB cluster snapshot.
  - getLicenseModel
```
public String getLicenseModel()
```
    The license model information for this DB cluster snapshot.
    
    Returns:
    
    The license model information for this DB cluster snapshot.
  - withLicenseModel
```
public DBClusterSnapshot withLicenseModel(String licenseModel)
```
    The license model information for this DB cluster snapshot.
    
    Parameters:
    
    licenseModel - 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)
```
    The type of the DB cluster snapshot.
    
    Parameters:
    
    snapshotType - The type of the DB cluster snapshot.
  - getSnapshotType
```
public String getSnapshotType()
```
    The type of the DB cluster snapshot.
    
    Returns:
    
    The type of the DB cluster snapshot.
  - withSnapshotType
```
public DBClusterSnapshot withSnapshotType(String snapshotType)
```
    The type of the DB cluster snapshot.
    
    Parameters:
    
    snapshotType - 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)
```
    The percentage of the estimated data that has been transferred.
    
    Parameters:
    
    percentProgress - The percentage of the estimated data that has been transferred.
  - getPercentProgress
```
public Integer getPercentProgress()
```
    The percentage of the estimated data that has been transferred.
    
    Returns:
    
    The percentage of the estimated data that has been transferred.
  - withPercentProgress
```
public DBClusterSnapshot withPercentProgress(Integer percentProgress)
```
    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.
  - setStorageEncrypted
```
public void setStorageEncrypted(Boolean storageEncrypted)
```
    Indicates whether the DB cluster snapshot is encrypted.
    
    Parameters:
    
    storageEncrypted - Indicates whether the DB cluster snapshot is encrypted.
  - getStorageEncrypted
```
public Boolean getStorageEncrypted()
```
    Indicates whether the DB cluster snapshot is encrypted.
    
    Returns:
    
    Indicates whether the DB cluster snapshot is encrypted.
  - withStorageEncrypted
```
public DBClusterSnapshot withStorageEncrypted(Boolean storageEncrypted)
```
    Indicates whether the DB cluster snapshot is encrypted.
    
    Parameters:
    
    storageEncrypted - Indicates 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()
```
    Indicates whether the DB cluster snapshot is encrypted.
    
    Returns:
    
    Indicates whether the DB cluster snapshot is encrypted.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    Returns:
    
    If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
  - withKmsKeyId
```
public DBClusterSnapshot withKmsKeyId(String kmsKeyId)
```
    If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterSnapshotArn
```
public void setDBClusterSnapshotArn(String dBClusterSnapshotArn)
```
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    
    Parameters:
    
    dBClusterSnapshotArn - The Amazon Resource Name (ARN) for the DB cluster snapshot.
  - getDBClusterSnapshotArn
```
public String getDBClusterSnapshotArn()
```
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
  - withDBClusterSnapshotArn
```
public DBClusterSnapshot withDBClusterSnapshotArn(String dBClusterSnapshotArn)
```
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    
    Parameters:
    
    dBClusterSnapshotArn - The Amazon Resource Name (ARN) for the DB cluster snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceDBClusterSnapshotArn
```
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.
    
    Parameters:
    
    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.
  - getSourceDBClusterSnapshotArn
```
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.
    
    Returns:
    
    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.
  - withSourceDBClusterSnapshotArn
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIAMDatabaseAuthenticationEnabled
```
public void setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
```
    Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
    
    Parameters:
    
    iAMDatabaseAuthenticationEnabled - Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
  - getIAMDatabaseAuthenticationEnabled
```
public Boolean getIAMDatabaseAuthenticationEnabled()
```
    Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
    
    Returns:
    
    Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
  - withIAMDatabaseAuthenticationEnabled
```
public DBClusterSnapshot withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
```
    Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
    
    Parameters:
    
    iAMDatabaseAuthenticationEnabled - Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIAMDatabaseAuthenticationEnabled
```
public Boolean isIAMDatabaseAuthenticationEnabled()
```
    Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
    
    Returns:
    
    Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
  - getTagList
```
public List<Tag> getTagList()
```
    Returns:
  - setTagList
```
public void setTagList(Collection<Tag> tagList)
```
    Parameters:
    
    tagList -
  - withTagList
```
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.
    
    Parameters:
    
    tagList -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTagList
```
public DBClusterSnapshot withTagList(Collection<Tag> tagList)
```
    Parameters:
    
    tagList -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBSystemId
```
public void setDBSystemId(String dBSystemId)
```
    Reserved for future use.
    
    Parameters:
    
    dBSystemId - Reserved for future use.
  - getDBSystemId
```
public String getDBSystemId()
```
    Reserved for future use.
    
    Returns:
    
    Reserved for future use.
  - withDBSystemId
```
public DBClusterSnapshot withDBSystemId(String dBSystemId)
```
    Reserved for future use.
    
    Parameters:
    
    dBSystemId - Reserved for future use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageType
```
public void setStorageType(String storageType)
```
    The storage type associated with the DB cluster snapshot.
    
    This setting is only for Aurora DB clusters.
    
    Parameters:
    
    storageType - The storage type associated with the DB cluster snapshot.
    
    This setting is only for Aurora DB clusters.
  - getStorageType
```
public String getStorageType()
```
    The storage type associated with the DB cluster snapshot.
    
    This setting is only for Aurora DB clusters.
    
    Returns:
    
    The storage type associated with the DB cluster snapshot.
    
    This setting is only for Aurora DB clusters.
  - withStorageType
```
public DBClusterSnapshot withStorageType(String storageType)
```
    The storage type associated with the DB cluster snapshot.
    
    This setting is only for Aurora DB clusters.
    
    Parameters:
    
    storageType - The storage type associated with the DB cluster snapshot.
    
    This setting is only for Aurora DB clusters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDbClusterResourceId
```
public void setDbClusterResourceId(String dbClusterResourceId)
```
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    
    Parameters:
    
    dbClusterResourceId - The resource ID of the DB cluster that this DB cluster snapshot was created from.
  - getDbClusterResourceId
```
public String getDbClusterResourceId()
```
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    
    Returns:
    
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
  - withDbClusterResourceId
```
public DBClusterSnapshot withDbClusterResourceId(String dbClusterResourceId)
```
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    
    Parameters:
    
    dbClusterResourceId - The resource ID 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.
  - setStorageThroughput
```
public void setStorageThroughput(Integer storageThroughput)
```
    The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
    
    This setting is only for non-Aurora Multi-AZ DB clusters.
    
    Parameters:
    
    storageThroughput - The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
    
    This setting is only for non-Aurora Multi-AZ DB clusters.
  - getStorageThroughput
```
public Integer getStorageThroughput()
```
    The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
    
    This setting is only for non-Aurora Multi-AZ DB clusters.
    
    Returns:
    
    The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
    
    This setting is only for non-Aurora Multi-AZ DB clusters.
  - withStorageThroughput
```
public DBClusterSnapshot withStorageThroughput(Integer storageThroughput)
```
    The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
    
    This setting is only for non-Aurora Multi-AZ DB clusters.
    
    Parameters:
    
    storageThroughput - The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
    
    This setting is only for non-Aurora Multi-AZ DB clusters.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

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

setEngineMode

getEngineMode

withEngineMode

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

setDBClusterSnapshotArn

getDBClusterSnapshotArn

withDBClusterSnapshotArn

setSourceDBClusterSnapshotArn

getSourceDBClusterSnapshotArn

withSourceDBClusterSnapshotArn

setIAMDatabaseAuthenticationEnabled

getIAMDatabaseAuthenticationEnabled

withIAMDatabaseAuthenticationEnabled

isIAMDatabaseAuthenticationEnabled

getTagList

setTagList

withTagList

withTagList

setDBSystemId

getDBSystemId