DBCluster (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class DBCluster
extends Object
implements Serializable, Cloneable
```
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBClusters action.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DBCluster()

Constructors
Constructor and Description
`DBCluster()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DBCluster`	`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 can be created in.
`Integer`	`getBackupRetentionPeriod()` Specifies the number of days for which automatic DB snapshots are retained.
`String`	`getCharacterSetName()` If present, specifies the name of the character set that this cluster is associated with.
`String`	`getDatabaseName()` Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created.
`String`	`getDBClusterIdentifier()` Contains a user-supplied DB cluster identifier.
`List<DBClusterMember>`	`getDBClusterMembers()` Provides the list of instances that make up the DB cluster.
`List<DBClusterOptionGroupStatus>`	`getDBClusterOptionGroupMemberships()` Provides the list of option group memberships for this DB cluster.
`String`	`getDBClusterParameterGroup()` Specifies the name of the DB cluster parameter group for the DB cluster.
`String`	`getDbClusterResourceId()` The region-unique, immutable identifier for the DB cluster.
`String`	`getDBSubnetGroup()` Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
`Date`	`getEarliestRestorableTime()` Specifies the earliest time to which a database can be restored with point-in-time restore.
`String`	`getEndpoint()` Specifies the connection endpoint for the primary instance of the DB cluster.
`String`	`getEngine()` Provides the name of the database engine to be used for this DB cluster.
`String`	`getEngineVersion()` Indicates the database engine version.
`String`	`getHostedZoneId()` Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
`String`	`getKmsKeyId()` If `StorageEncrypted` is true, the KMS key identifier for the encrypted DB cluster.
`Date`	`getLatestRestorableTime()` Specifies the latest time to which a database can be restored with point-in-time restore.
`String`	`getMasterUsername()` Contains the master username for the DB cluster.
`String`	`getPercentProgress()` Specifies the progress of the operation as a percentage.
`Integer`	`getPort()` Specifies the port that the database engine is listening on.
`String`	`getPreferredBackupWindow()` Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
`String`	`getPreferredMaintenanceWindow()` Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`List<String>`	`getReadReplicaIdentifiers()` Contains one or more identifiers of the Read Replicas associated with this DB cluster.
`String`	`getReplicationSourceIdentifier()` Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
`String`	`getStatus()` Specifies the current state of this DB cluster.
`Boolean`	`getStorageEncrypted()` Specifies whether the DB cluster is encrypted.
`List<VpcSecurityGroupMembership>`	`getVpcSecurityGroups()` Provides a list of VPC security groups that the DB cluster belongs to.
`int`	`hashCode()`
`Boolean`	`isStorageEncrypted()` Specifies whether the DB cluster 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 can be created in.
`void`	`setBackupRetentionPeriod(Integer backupRetentionPeriod)` Specifies the number of days for which automatic DB snapshots are retained.
`void`	`setCharacterSetName(String characterSetName)` If present, specifies the name of the character set that this cluster is associated with.
`void`	`setDatabaseName(String databaseName)` Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created.
`void`	`setDBClusterIdentifier(String dBClusterIdentifier)` Contains a user-supplied DB cluster identifier.
`void`	`setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)` Provides the list of instances that make up the DB cluster.
`void`	`setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)` Provides the list of option group memberships for this DB cluster.
`void`	`setDBClusterParameterGroup(String dBClusterParameterGroup)` Specifies the name of the DB cluster parameter group for the DB cluster.
`void`	`setDbClusterResourceId(String dbClusterResourceId)` The region-unique, immutable identifier for the DB cluster.
`void`	`setDBSubnetGroup(String dBSubnetGroup)` Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
`void`	`setEarliestRestorableTime(Date earliestRestorableTime)` Specifies the earliest time to which a database can be restored with point-in-time restore.
`void`	`setEndpoint(String endpoint)` Specifies the connection endpoint for the primary instance of the DB cluster.
`void`	`setEngine(String engine)` Provides the name of the database engine to be used for this DB cluster.
`void`	`setEngineVersion(String engineVersion)` Indicates the database engine version.
`void`	`setHostedZoneId(String hostedZoneId)` Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
`void`	`setKmsKeyId(String kmsKeyId)` If `StorageEncrypted` is true, the KMS key identifier for the encrypted DB cluster.
`void`	`setLatestRestorableTime(Date latestRestorableTime)` Specifies the latest time to which a database can be restored with point-in-time restore.
`void`	`setMasterUsername(String masterUsername)` Contains the master username for the DB cluster.
`void`	`setPercentProgress(String percentProgress)` Specifies the progress of the operation as a percentage.
`void`	`setPort(Integer port)` Specifies the port that the database engine is listening on.
`void`	`setPreferredBackupWindow(String preferredBackupWindow)` Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
`void`	`setPreferredMaintenanceWindow(String preferredMaintenanceWindow)` Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`void`	`setReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)` Contains one or more identifiers of the Read Replicas associated with this DB cluster.
`void`	`setReplicationSourceIdentifier(String replicationSourceIdentifier)` Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
`void`	`setStatus(String status)` Specifies the current state of this DB cluster.
`void`	`setStorageEncrypted(Boolean storageEncrypted)` Specifies whether the DB cluster is encrypted.
`void`	`setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)` Provides a list of VPC security groups that the DB cluster belongs to.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DBCluster`	`withAllocatedStorage(Integer allocatedStorage)` Specifies the allocated storage size in gigabytes (GB).
`DBCluster`	`withAvailabilityZones(Collection<String> availabilityZones)` Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
`DBCluster`	`withAvailabilityZones(String... availabilityZones)` Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
`DBCluster`	`withBackupRetentionPeriod(Integer backupRetentionPeriod)` Specifies the number of days for which automatic DB snapshots are retained.
`DBCluster`	`withCharacterSetName(String characterSetName)` If present, specifies the name of the character set that this cluster is associated with.
`DBCluster`	`withDatabaseName(String databaseName)` Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created.
`DBCluster`	`withDBClusterIdentifier(String dBClusterIdentifier)` Contains a user-supplied DB cluster identifier.
`DBCluster`	`withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)` Provides the list of instances that make up the DB cluster.
`DBCluster`	`withDBClusterMembers(DBClusterMember... dBClusterMembers)` Provides the list of instances that make up the DB cluster.
`DBCluster`	`withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)` Provides the list of option group memberships for this DB cluster.
`DBCluster`	`withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)` Provides the list of option group memberships for this DB cluster.
`DBCluster`	`withDBClusterParameterGroup(String dBClusterParameterGroup)` Specifies the name of the DB cluster parameter group for the DB cluster.
`DBCluster`	`withDbClusterResourceId(String dbClusterResourceId)` The region-unique, immutable identifier for the DB cluster.
`DBCluster`	`withDBSubnetGroup(String dBSubnetGroup)` Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
`DBCluster`	`withEarliestRestorableTime(Date earliestRestorableTime)` Specifies the earliest time to which a database can be restored with point-in-time restore.
`DBCluster`	`withEndpoint(String endpoint)` Specifies the connection endpoint for the primary instance of the DB cluster.
`DBCluster`	`withEngine(String engine)` Provides the name of the database engine to be used for this DB cluster.
`DBCluster`	`withEngineVersion(String engineVersion)` Indicates the database engine version.
`DBCluster`	`withHostedZoneId(String hostedZoneId)` Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
`DBCluster`	`withKmsKeyId(String kmsKeyId)` If `StorageEncrypted` is true, the KMS key identifier for the encrypted DB cluster.
`DBCluster`	`withLatestRestorableTime(Date latestRestorableTime)` Specifies the latest time to which a database can be restored with point-in-time restore.
`DBCluster`	`withMasterUsername(String masterUsername)` Contains the master username for the DB cluster.
`DBCluster`	`withPercentProgress(String percentProgress)` Specifies the progress of the operation as a percentage.
`DBCluster`	`withPort(Integer port)` Specifies the port that the database engine is listening on.
`DBCluster`	`withPreferredBackupWindow(String preferredBackupWindow)` Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
`DBCluster`	`withPreferredMaintenanceWindow(String preferredMaintenanceWindow)` Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`DBCluster`	`withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)` Contains one or more identifiers of the Read Replicas associated with this DB cluster.
`DBCluster`	`withReadReplicaIdentifiers(String... readReplicaIdentifiers)` Contains one or more identifiers of the Read Replicas associated with this DB cluster.
`DBCluster`	`withReplicationSourceIdentifier(String replicationSourceIdentifier)` Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
`DBCluster`	`withStatus(String status)` Specifies the current state of this DB cluster.
`DBCluster`	`withStorageEncrypted(Boolean storageEncrypted)` Specifies whether the DB cluster is encrypted.
`DBCluster`	`withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)` Provides a list of VPC security groups that the DB cluster belongs to.
`DBCluster`	`withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)` Provides a list of VPC security groups that the DB cluster belongs to.

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

- Constructor Detail
  - DBCluster
```
public DBCluster()
```
- Method Detail
  - 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 DBCluster 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.
  - getAvailabilityZones
```
public List<String> getAvailabilityZones()
```
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    
    Returns:
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
  - setAvailabilityZones
```
public void setAvailabilityZones(Collection<String> availabilityZones)
```
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    
    Parameters:
    
    availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
  - withAvailabilityZones
```
public DBCluster withAvailabilityZones(String... availabilityZones)
```
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created 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 can be created in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAvailabilityZones
```
public DBCluster withAvailabilityZones(Collection<String> availabilityZones)
```
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    
    Parameters:
    
    availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupRetentionPeriod
```
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
```
    Specifies the number of days for which automatic DB snapshots are retained.
    
    Parameters:
    
    backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.
  - getBackupRetentionPeriod
```
public Integer getBackupRetentionPeriod()
```
    Specifies the number of days for which automatic DB snapshots are retained.
    
    Returns:
    
    Specifies the number of days for which automatic DB snapshots are retained.
  - withBackupRetentionPeriod
```
public DBCluster withBackupRetentionPeriod(Integer backupRetentionPeriod)
```
    Specifies the number of days for which automatic DB snapshots are retained.
    
    Parameters:
    
    backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCharacterSetName
```
public void setCharacterSetName(String characterSetName)
```
    If present, specifies the name of the character set that this cluster is associated with.
    
    Parameters:
    
    characterSetName - If present, specifies the name of the character set that this cluster is associated with.
  - getCharacterSetName
```
public String getCharacterSetName()
```
    If present, specifies the name of the character set that this cluster is associated with.
    
    Returns:
    
    If present, specifies the name of the character set that this cluster is associated with.
  - withCharacterSetName
```
public DBCluster withCharacterSetName(String characterSetName)
```
    If present, specifies the name of the character set that this cluster is associated with.
    
    Parameters:
    
    characterSetName - If present, specifies the name of the character set that this cluster is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
    
    Parameters:
    
    databaseName - Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - getDatabaseName
```
public String getDatabaseName()
```
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
    
    Returns:
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - withDatabaseName
```
public DBCluster withDatabaseName(String databaseName)
```
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
    
    Parameters:
    
    databaseName - Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterIdentifier
```
public void setDBClusterIdentifier(String dBClusterIdentifier)
```
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
    
    Parameters:
    
    dBClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - getDBClusterIdentifier
```
public String getDBClusterIdentifier()
```
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
    
    Returns:
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - withDBClusterIdentifier
```
public DBCluster withDBClusterIdentifier(String dBClusterIdentifier)
```
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
    
    Parameters:
    
    dBClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterParameterGroup
```
public void setDBClusterParameterGroup(String dBClusterParameterGroup)
```
    Specifies the name of the DB cluster parameter group for the DB cluster.
    
    Parameters:
    
    dBClusterParameterGroup - Specifies the name of the DB cluster parameter group for the DB cluster.
  - getDBClusterParameterGroup
```
public String getDBClusterParameterGroup()
```
    Specifies the name of the DB cluster parameter group for the DB cluster.
    
    Returns:
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - withDBClusterParameterGroup
```
public DBCluster withDBClusterParameterGroup(String dBClusterParameterGroup)
```
    Specifies the name of the DB cluster parameter group for the DB cluster.
    
    Parameters:
    
    dBClusterParameterGroup - Specifies the name of the DB cluster parameter group for the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBSubnetGroup
```
public void setDBSubnetGroup(String dBSubnetGroup)
```
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
    
    Parameters:
    
    dBSubnetGroup - Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - getDBSubnetGroup
```
public String getDBSubnetGroup()
```
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
    
    Returns:
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - withDBSubnetGroup
```
public DBCluster withDBSubnetGroup(String dBSubnetGroup)
```
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
    
    Parameters:
    
    dBSubnetGroup - Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Specifies the current state of this DB cluster.
    
    Parameters:
    
    status - Specifies the current state of this DB cluster.
  - getStatus
```
public String getStatus()
```
    Specifies the current state of this DB cluster.
    
    Returns:
    
    Specifies the current state of this DB cluster.
  - withStatus
```
public DBCluster withStatus(String status)
```
    Specifies the current state of this DB cluster.
    
    Parameters:
    
    status - Specifies the current state of this DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPercentProgress
```
public void setPercentProgress(String percentProgress)
```
    Specifies the progress of the operation as a percentage.
    
    Parameters:
    
    percentProgress - Specifies the progress of the operation as a percentage.
  - getPercentProgress
```
public String getPercentProgress()
```
    Specifies the progress of the operation as a percentage.
    
    Returns:
    
    Specifies the progress of the operation as a percentage.
  - withPercentProgress
```
public DBCluster withPercentProgress(String percentProgress)
```
    Specifies the progress of the operation as a percentage.
    
    Parameters:
    
    percentProgress - Specifies the progress of the operation as a percentage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEarliestRestorableTime
```
public void setEarliestRestorableTime(Date earliestRestorableTime)
```
    Specifies the earliest time to which a database can be restored with point-in-time restore.
    
    Parameters:
    
    earliestRestorableTime - Specifies the earliest time to which a database can be restored with point-in-time restore.
  - getEarliestRestorableTime
```
public Date getEarliestRestorableTime()
```
    Specifies the earliest time to which a database can be restored with point-in-time restore.
    
    Returns:
    
    Specifies the earliest time to which a database can be restored with point-in-time restore.
  - withEarliestRestorableTime
```
public DBCluster withEarliestRestorableTime(Date earliestRestorableTime)
```
    Specifies the earliest time to which a database can be restored with point-in-time restore.
    
    Parameters:
    
    earliestRestorableTime - Specifies the earliest time to which a database can be restored with point-in-time restore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Specifies the connection endpoint for the primary instance of the DB cluster.
    
    Parameters:
    
    endpoint - Specifies the connection endpoint for the primary instance of the DB cluster.
  - getEndpoint
```
public String getEndpoint()
```
    Specifies the connection endpoint for the primary instance of the DB cluster.
    
    Returns:
    
    Specifies the connection endpoint for the primary instance of the DB cluster.
  - withEndpoint
```
public DBCluster withEndpoint(String endpoint)
```
    Specifies the connection endpoint for the primary instance of the DB cluster.
    
    Parameters:
    
    endpoint - Specifies the connection endpoint for the primary instance of the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngine
```
public void setEngine(String engine)
```
    Provides the name of the database engine to be used for this DB cluster.
    
    Parameters:
    
    engine - Provides the name of the database engine to be used for this DB cluster.
  - getEngine
```
public String getEngine()
```
    Provides the name of the database engine to be used for this DB cluster.
    
    Returns:
    
    Provides the name of the database engine to be used for this DB cluster.
  - withEngine
```
public DBCluster withEngine(String engine)
```
    Provides the name of the database engine to be used for this DB cluster.
    
    Parameters:
    
    engine - Provides the name of the database engine to be used for this DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    Indicates the database engine version.
    
    Parameters:
    
    engineVersion - Indicates the database engine version.
  - getEngineVersion
```
public String getEngineVersion()
```
    Indicates the database engine version.
    
    Returns:
    
    Indicates the database engine version.
  - withEngineVersion
```
public DBCluster withEngineVersion(String engineVersion)
```
    Indicates the database engine version.
    
    Parameters:
    
    engineVersion - Indicates the database engine version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLatestRestorableTime
```
public void setLatestRestorableTime(Date latestRestorableTime)
```
    Specifies the latest time to which a database can be restored with point-in-time restore.
    
    Parameters:
    
    latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.
  - getLatestRestorableTime
```
public Date getLatestRestorableTime()
```
    Specifies the latest time to which a database can be restored with point-in-time restore.
    
    Returns:
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - withLatestRestorableTime
```
public DBCluster withLatestRestorableTime(Date latestRestorableTime)
```
    Specifies the latest time to which a database can be restored with point-in-time restore.
    
    Parameters:
    
    latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.
    
    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 database engine is listening on.
    
    Parameters:
    
    port - Specifies the port that the database engine is listening on.
  - getPort
```
public Integer getPort()
```
    Specifies the port that the database engine is listening on.
    
    Returns:
    
    Specifies the port that the database engine is listening on.
  - withPort
```
public DBCluster withPort(Integer port)
```
    Specifies the port that the database engine is listening on.
    
    Parameters:
    
    port - Specifies the port that the database engine is listening on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMasterUsername
```
public void setMasterUsername(String masterUsername)
```
    Contains the master username for the DB cluster.
    
    Parameters:
    
    masterUsername - Contains the master username for the DB cluster.
  - getMasterUsername
```
public String getMasterUsername()
```
    Contains the master username for the DB cluster.
    
    Returns:
    
    Contains the master username for the DB cluster.
  - withMasterUsername
```
public DBCluster withMasterUsername(String masterUsername)
```
    Contains the master username for the DB cluster.
    
    Parameters:
    
    masterUsername - Contains the master username for the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDBClusterOptionGroupMemberships
```
public List<DBClusterOptionGroupStatus> getDBClusterOptionGroupMemberships()
```
    Provides the list of option group memberships for this DB cluster.
    
    Returns:
    
    Provides the list of option group memberships for this DB cluster.
  - setDBClusterOptionGroupMemberships
```
public void setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
```
    Provides the list of option group memberships for this DB cluster.
    
    Parameters:
    
    dBClusterOptionGroupMemberships - Provides the list of option group memberships for this DB cluster.
  - withDBClusterOptionGroupMemberships
```
public DBCluster withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
```
    Provides the list of option group memberships for this DB cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setDBClusterOptionGroupMemberships(java.util.Collection) or withDBClusterOptionGroupMemberships(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dBClusterOptionGroupMemberships - Provides the list of option group memberships for this DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDBClusterOptionGroupMemberships
```
public DBCluster withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
```
    Provides the list of option group memberships for this DB cluster.
    
    Parameters:
    
    dBClusterOptionGroupMemberships - Provides the list of option group memberships for this DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferredBackupWindow
```
public void setPreferredBackupWindow(String preferredBackupWindow)
```
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
    
    Parameters:
    
    preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - getPreferredBackupWindow
```
public String getPreferredBackupWindow()
```
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
    
    Returns:
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - withPreferredBackupWindow
```
public DBCluster withPreferredBackupWindow(String preferredBackupWindow)
```
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
    
    Parameters:
    
    preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferredMaintenanceWindow
```
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Parameters:
    
    preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - getPreferredMaintenanceWindow
```
public String getPreferredMaintenanceWindow()
```
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - withPreferredMaintenanceWindow
```
public DBCluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Parameters:
    
    preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReplicationSourceIdentifier
```
public void setReplicationSourceIdentifier(String replicationSourceIdentifier)
```
    Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
    
    Parameters:
    
    replicationSourceIdentifier - Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
  - getReplicationSourceIdentifier
```
public String getReplicationSourceIdentifier()
```
    Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
    
    Returns:
    
    Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
  - withReplicationSourceIdentifier
```
public DBCluster withReplicationSourceIdentifier(String replicationSourceIdentifier)
```
    Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
    
    Parameters:
    
    replicationSourceIdentifier - Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReadReplicaIdentifiers
```
public List<String> getReadReplicaIdentifiers()
```
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    
    Returns:
    
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
  - setReadReplicaIdentifiers
```
public void setReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
```
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    
    Parameters:
    
    readReplicaIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB cluster.
  - withReadReplicaIdentifiers
```
public DBCluster withReadReplicaIdentifiers(String... readReplicaIdentifiers)
```
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setReadReplicaIdentifiers(java.util.Collection) or withReadReplicaIdentifiers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    readReplicaIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReadReplicaIdentifiers
```
public DBCluster withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
```
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    
    Parameters:
    
    readReplicaIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDBClusterMembers
```
public List<DBClusterMember> getDBClusterMembers()
```
    Provides the list of instances that make up the DB cluster.
    
    Returns:
    
    Provides the list of instances that make up the DB cluster.
  - setDBClusterMembers
```
public void setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
```
    Provides the list of instances that make up the DB cluster.
    
    Parameters:
    
    dBClusterMembers - Provides the list of instances that make up the DB cluster.
  - withDBClusterMembers
```
public DBCluster withDBClusterMembers(DBClusterMember... dBClusterMembers)
```
    Provides the list of instances that make up the DB cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setDBClusterMembers(java.util.Collection) or withDBClusterMembers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dBClusterMembers - Provides the list of instances that make up the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDBClusterMembers
```
public DBCluster withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
```
    Provides the list of instances that make up the DB cluster.
    
    Parameters:
    
    dBClusterMembers - Provides the list of instances that make up the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcSecurityGroups
```
public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
```
    Provides a list of VPC security groups that the DB cluster belongs to.
    
    Returns:
    
    Provides a list of VPC security groups that the DB cluster belongs to.
  - setVpcSecurityGroups
```
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
```
    Provides a list of VPC security groups that the DB cluster belongs to.
    
    Parameters:
    
    vpcSecurityGroups - Provides a list of VPC security groups that the DB cluster belongs to.
  - withVpcSecurityGroups
```
public DBCluster withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
```
    Provides a list of VPC security groups that the DB cluster belongs to.
    
    NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroups(java.util.Collection) or withVpcSecurityGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    vpcSecurityGroups - Provides a list of VPC security groups that the DB cluster belongs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVpcSecurityGroups
```
public DBCluster withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
```
    Provides a list of VPC security groups that the DB cluster belongs to.
    
    Parameters:
    
    vpcSecurityGroups - Provides a list of VPC security groups that the DB cluster belongs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostedZoneId
```
public void setHostedZoneId(String hostedZoneId)
```
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    
    Parameters:
    
    hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - getHostedZoneId
```
public String getHostedZoneId()
```
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    
    Returns:
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - withHostedZoneId
```
public DBCluster withHostedZoneId(String hostedZoneId)
```
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    
    Parameters:
    
    hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    
    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 is encrypted.
    
    Parameters:
    
    storageEncrypted - Specifies whether the DB cluster is encrypted.
  - getStorageEncrypted
```
public Boolean getStorageEncrypted()
```
    Specifies whether the DB cluster is encrypted.
    
    Returns:
    
    Specifies whether the DB cluster is encrypted.
  - withStorageEncrypted
```
public DBCluster withStorageEncrypted(Boolean storageEncrypted)
```
    Specifies whether the DB cluster is encrypted.
    
    Parameters:
    
    storageEncrypted - Specifies whether the DB cluster 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 is encrypted.
    
    Returns:
    
    Specifies whether the DB cluster is encrypted.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
    
    Returns:
    
    If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
  - withKmsKeyId
```
public DBCluster withKmsKeyId(String kmsKeyId)
```
    If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDbClusterResourceId
```
public void setDbClusterResourceId(String dbClusterResourceId)
```
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
    
    Parameters:
    
    dbClusterResourceId - The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - getDbClusterResourceId
```
public String getDbClusterResourceId()
```
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
    
    Returns:
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - withDbClusterResourceId
```
public DBCluster withDbClusterResourceId(String dbClusterResourceId)
```
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
    
    Parameters:
    
    dbClusterResourceId - The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
    
    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 DBCluster clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DBCluster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DBCluster

Method Detail

setAllocatedStorage

getAllocatedStorage

withAllocatedStorage

getAvailabilityZones

setAvailabilityZones

withAvailabilityZones

withAvailabilityZones

setBackupRetentionPeriod

getBackupRetentionPeriod

withBackupRetentionPeriod

setCharacterSetName

getCharacterSetName

withCharacterSetName

setDatabaseName

getDatabaseName

withDatabaseName

setDBClusterIdentifier

getDBClusterIdentifier

withDBClusterIdentifier

setDBClusterParameterGroup

getDBClusterParameterGroup

withDBClusterParameterGroup

setDBSubnetGroup

getDBSubnetGroup

withDBSubnetGroup

setStatus

getStatus

withStatus

setPercentProgress

getPercentProgress

withPercentProgress

setEarliestRestorableTime

getEarliestRestorableTime

withEarliestRestorableTime

setEndpoint

getEndpoint

withEndpoint

setEngine

getEngine

withEngine

setEngineVersion

getEngineVersion

withEngineVersion

setLatestRestorableTime

getLatestRestorableTime

withLatestRestorableTime

setPort

getPort

withPort

setMasterUsername

getMasterUsername

withMasterUsername

getDBClusterOptionGroupMemberships

setDBClusterOptionGroupMemberships

withDBClusterOptionGroupMemberships

withDBClusterOptionGroupMemberships

setPreferredBackupWindow

getPreferredBackupWindow

withPreferredBackupWindow

setPreferredMaintenanceWindow

getPreferredMaintenanceWindow

withPreferredMaintenanceWindow

setReplicationSourceIdentifier

getReplicationSourceIdentifier

withReplicationSourceIdentifier

getReadReplicaIdentifiers

setReadReplicaIdentifiers

withReadReplicaIdentifiers

withReadReplicaIdentifiers

getDBClusterMembers

setDBClusterMembers

withDBClusterMembers