DBCluster (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.rds.model.DBCluster

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBCluster.Builder,DBCluster>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DBCluster
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DBCluster.Builder,DBCluster>
```
Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DBCluster.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DBCluster.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`allocatedStorage()` For all database engines except Amazon Aurora, `AllocatedStorage` specifies the allocated storage size in gibibytes (GiB).
`List<DBClusterRole>`	`associatedRoles()` Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
`List<String>`	`availabilityZones()` Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
`Long`	`backtrackConsumedChangeRecords()` The number of change records stored for Backtrack.
`Long`	`backtrackWindow()` The target backtrack window, in seconds.
`Integer`	`backupRetentionPeriod()` Specifies the number of days for which automatic DB snapshots are retained.
`static DBCluster.Builder`	`builder()`
`Integer`	`capacity()` Returns the value of the Capacity property for this object.
`String`	`characterSetName()` If present, specifies the name of the character set that this cluster is associated with.
`String`	`cloneGroupId()` Identifies the clone group to which the DB cluster is associated.
`Instant`	`clusterCreateTime()` Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
`List<String>`	`customEndpoints()` Identifies all custom endpoints associated with the cluster.
`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.
`String`	`dbClusterArn()` The Amazon Resource Name (ARN) for the DB cluster.
`String`	`dbClusterIdentifier()` Contains a user-supplied DB cluster identifier.
`List<DBClusterMember>`	`dbClusterMembers()` Provides the list of instances that make up the DB cluster.
`List<DBClusterOptionGroupStatus>`	`dbClusterOptionGroupMemberships()` Provides the list of option group memberships for this DB cluster.
`String`	`dbClusterParameterGroup()` Specifies the name of the DB cluster parameter group for the DB cluster.
`String`	`dbClusterResourceId()` The AWS Region-unique, immutable identifier for the DB cluster.
`String`	`dbSubnetGroup()` Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
`Boolean`	`deletionProtection()` Indicates if the DB cluster has deletion protection enabled.
`Instant`	`earliestBacktrackTime()` The earliest time to which a DB cluster can be backtracked.
`Instant`	`earliestRestorableTime()` The earliest time to which a database can be restored with point-in-time restore.
`List<String>`	`enabledCloudwatchLogsExports()` A list of log types that this DB cluster is configured to export to CloudWatch Logs.
`String`	`endpoint()` Specifies the connection endpoint for the primary instance of the DB cluster.
`String`	`engine()` Provides the name of the database engine to be used for this DB cluster.
`String`	`engineMode()` The DB engine mode of the DB cluster, either `provisioned`, `serverless`, or `parallelquery`.
`String`	`engineVersion()` Indicates the database engine version.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`hostedZoneId()` Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
`Boolean`	`httpEndpointEnabled()`
`Boolean`	`iamDatabaseAuthenticationEnabled()` True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
`String`	`kmsKeyId()` If `StorageEncrypted` is true, the AWS KMS key identifier for the encrypted DB cluster.
`Instant`	`latestRestorableTime()` Specifies the latest time to which a database can be restored with point-in-time restore.
`String`	`masterUsername()` Contains the master username for the DB cluster.
`Boolean`	`multiAZ()` Specifies whether the DB cluster has instances in multiple Availability Zones.
`String`	`percentProgress()` Specifies the progress of the operation as a percentage.
`Integer`	`port()` Specifies the port that the database engine is listening on.
`String`	`preferredBackupWindow()` Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
`String`	`preferredMaintenanceWindow()` Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`String`	`readerEndpoint()` The reader endpoint for the DB cluster.
`List<String>`	`readReplicaIdentifiers()` Contains one or more identifiers of the Read Replicas associated with this DB cluster.
`String`	`replicationSourceIdentifier()` Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
`ScalingConfigurationInfo`	`scalingConfigurationInfo()` Returns the value of the ScalingConfigurationInfo property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DBCluster.Builder>`	`serializableBuilderClass()`
`String`	`status()` Specifies the current state of this DB cluster.
`Boolean`	`storageEncrypted()` Specifies whether the DB cluster is encrypted.
`DBCluster.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`List<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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - allocatedStorage
```
public Integer allocatedStorage()
```
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.
    
    Returns:
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.
  - availabilityZones
```
public List<String> availabilityZones()
```
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
  - backupRetentionPeriod
```
public Integer backupRetentionPeriod()
```
    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.
  - characterSetName
```
public String characterSetName()
```
    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.
  - databaseName
```
public 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.
    
    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.
  - dbClusterIdentifier
```
public String dbClusterIdentifier()
```
    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.
  - dbClusterParameterGroup
```
public String dbClusterParameterGroup()
```
    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.
  - dbSubnetGroup
```
public String dbSubnetGroup()
```
    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.
  - status
```
public String status()
```
    Specifies the current state of this DB cluster.
    
    Returns:
    
    Specifies the current state of this DB cluster.
  - percentProgress
```
public String percentProgress()
```
    Specifies the progress of the operation as a percentage.
    
    Returns:
    
    Specifies the progress of the operation as a percentage.
  - earliestRestorableTime
```
public Instant earliestRestorableTime()
```
    The earliest time to which a database can be restored with point-in-time restore.
    
    Returns:
    
    The earliest time to which a database can be restored with point-in-time restore.
  - endpoint
```
public String endpoint()
```
    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.
  - readerEndpoint
```
public String readerEndpoint()
```
    The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
    
    If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
    
    Returns:
    
    The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
    
    If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - customEndpoints
```
public List<String> customEndpoints()
```
    Identifies all custom endpoints associated with the cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Identifies all custom endpoints associated with the cluster.
  - multiAZ
```
public Boolean multiAZ()
```
    Specifies whether the DB cluster has instances in multiple Availability Zones.
    
    Returns:
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - engine
```
public String engine()
```
    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.
  - engineVersion
```
public String engineVersion()
```
    Indicates the database engine version.
    
    Returns:
    
    Indicates the database engine version.
  - latestRestorableTime
```
public Instant latestRestorableTime()
```
    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.
  - port
```
public Integer port()
```
    Specifies the port that the database engine is listening on.
    
    Returns:
    
    Specifies the port that the database engine is listening on.
  - masterUsername
```
public String masterUsername()
```
    Contains the master username for the DB cluster.
    
    Returns:
    
    Contains the master username for the DB cluster.
  - dbClusterOptionGroupMemberships
```
public List<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships()
```
    Provides the list of option group memberships for this DB cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides the list of option group memberships for this DB cluster.
  - preferredBackupWindow
```
public String preferredBackupWindow()
```
    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.
  - preferredMaintenanceWindow
```
public String preferredMaintenanceWindow()
```
    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).
  - replicationSourceIdentifier
```
public String replicationSourceIdentifier()
```
    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.
  - readReplicaIdentifiers
```
public List<String> readReplicaIdentifiers()
```
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
  - dbClusterMembers
```
public List<DBClusterMember> dbClusterMembers()
```
    Provides the list of instances that make up the DB cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides the list of instances that make up the DB cluster.
  - vpcSecurityGroups
```
public List<VpcSecurityGroupMembership> vpcSecurityGroups()
```
    Provides a list of VPC security groups that the DB cluster belongs to.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides a list of VPC security groups that the DB cluster belongs to.
  - hostedZoneId
```
public String hostedZoneId()
```
    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.
  - storageEncrypted
```
public Boolean storageEncrypted()
```
    Specifies whether the DB cluster is encrypted.
    
    Returns:
    
    Specifies whether the DB cluster is encrypted.
  - kmsKeyId
```
public String kmsKeyId()
```
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
    
    Returns:
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - dbClusterResourceId
```
public String dbClusterResourceId()
```
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
    
    Returns:
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - dbClusterArn
```
public String dbClusterArn()
```
    The Amazon Resource Name (ARN) for the DB cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - associatedRoles
```
public List<DBClusterRole> associatedRoles()
```
    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
  - iamDatabaseAuthenticationEnabled
```
public Boolean iamDatabaseAuthenticationEnabled()
```
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    Returns:
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - cloneGroupId
```
public String cloneGroupId()
```
    Identifies the clone group to which the DB cluster is associated.
    
    Returns:
    
    Identifies the clone group to which the DB cluster is associated.
  - clusterCreateTime
```
public Instant clusterCreateTime()
```
    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).
  - earliestBacktrackTime
```
public Instant earliestBacktrackTime()
```
    The earliest time to which a DB cluster can be backtracked.
    
    Returns:
    
    The earliest time to which a DB cluster can be backtracked.
  - backtrackWindow
```
public Long backtrackWindow()
```
    The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
    
    Returns:
    
    The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
  - backtrackConsumedChangeRecords
```
public Long backtrackConsumedChangeRecords()
```
    The number of change records stored for Backtrack.
    
    Returns:
    
    The number of change records stored for Backtrack.
  - enabledCloudwatchLogsExports
```
public List<String> enabledCloudwatchLogsExports()
```
    A list of log types that this DB cluster is configured to export to CloudWatch Logs.
    
    Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of log types that this DB cluster is configured to export to CloudWatch Logs.
    
    Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
  - capacity
```
public Integer capacity()
```
    Returns the value of the Capacity property for this object.
    
    Returns:
    
    The value of the Capacity property for this object.
  - engineMode
```
public String engineMode()
```
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
    
    Returns:
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - scalingConfigurationInfo
```
public ScalingConfigurationInfo scalingConfigurationInfo()
```
    Returns the value of the ScalingConfigurationInfo property for this object.
    
    Returns:
    
    The value of the ScalingConfigurationInfo property for this object.
  - deletionProtection
```
public Boolean deletionProtection()
```
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
    
    Returns:
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - httpEndpointEnabled
```
public Boolean httpEndpointEnabled()
```
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    
    Returns:
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
  - toBuilder
```
public DBCluster.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DBCluster.Builder,DBCluster>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DBCluster.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBCluster.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class DBCluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

allocatedStorage

availabilityZones

backupRetentionPeriod

characterSetName

databaseName

dbClusterIdentifier

dbClusterParameterGroup

dbSubnetGroup

status

percentProgress

earliestRestorableTime

endpoint

readerEndpoint

customEndpoints

multiAZ

engine

engineVersion

latestRestorableTime

port

masterUsername

dbClusterOptionGroupMemberships

preferredBackupWindow

preferredMaintenanceWindow

replicationSourceIdentifier

readReplicaIdentifiers

dbClusterMembers

vpcSecurityGroups

hostedZoneId

storageEncrypted

kmsKeyId

dbClusterResourceId

dbClusterArn

associatedRoles

iamDatabaseAuthenticationEnabled

cloneGroupId

clusterCreateTime

earliestBacktrackTime

backtrackWindow

backtrackConsumedChangeRecords

enabledCloudwatchLogsExports

capacity

engineMode

scalingConfigurationInfo

deletionProtection

httpEndpointEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields