DBCluster (AWS Java SDK :: Services :: Amazon RDS 2.16.76 API)

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
`String`	`activityStreamKinesisStreamName()` The name of the Amazon Kinesis data stream used for the database activity stream.
`String`	`activityStreamKmsKeyId()` The AWS KMS key identifier used for encrypting messages in the database activity stream.
`ActivityStreamMode`	`activityStreamMode()` The mode of the database activity stream.
`String`	`activityStreamModeAsString()` The mode of the database activity stream.
`ActivityStreamStatus`	`activityStreamStatus()` The status of the database activity stream.
`String`	`activityStreamStatusAsString()` The status of the database activity stream.
`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 Availability Zones (AZs) where instances in the DB cluster can be created.
`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()` The current capacity of an Aurora Serverless DB cluster.
`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).
`Boolean`	`copyTagsToSnapshot()` Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
`Boolean`	`crossAccountClone()` Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.
`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.
`List<DomainMembership>`	`domainMemberships()` The Active Directory Domain membership records associated with the DB cluster.
`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()` 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`, `parallelquery`, `global`, or `multimaster`.
`String`	`engineVersion()` Indicates the database engine version.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`Boolean`	`globalWriteForwardingRequested()` Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database.
`WriteForwardingStatus`	`globalWriteForwardingStatus()` Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
`String`	`globalWriteForwardingStatusAsString()` Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
`boolean`	`hasAssociatedRoles()` Returns true if the AssociatedRoles property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasAvailabilityZones()` Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasCustomEndpoints()` Returns true if the CustomEndpoints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDbClusterMembers()` Returns true if the DBClusterMembers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDbClusterOptionGroupMemberships()` Returns true if the DBClusterOptionGroupMemberships property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDomainMemberships()` Returns true if the DomainMemberships property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnabledCloudwatchLogsExports()` Returns true if the EnabledCloudwatchLogsExports property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasReadReplicaIdentifiers()` Returns true if the ReadReplicaIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTagList()` Returns true if the TagList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasVpcSecurityGroups()` Returns true if the VpcSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`hostedZoneId()` Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
`Boolean`	`httpEndpointEnabled()` A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
`Boolean`	`iamDatabaseAuthenticationEnabled()` A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
`String`	`kmsKeyId()` If `StorageEncrypted` is enabled, 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.
`ClusterPendingModifiedValues`	`pendingModifiedValues()` A value that specifies that changes to the DB cluster are pending.
`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.
`List<Tag>`	`tagList()` Returns the value of the TagList property for this object.
`DBCluster.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<VpcSecurityGroupMembership>`	`vpcSecurityGroups()` Provides a list of VPC security groups that the DB cluster belongs to.

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

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

- Method Detail
  - allocatedStorage
```
public final 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 isn't 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 isn't fixed, but instead automatically adjusts as needed.
  - hasAvailabilityZones
```
public final boolean hasAvailabilityZones()
```
    Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - availabilityZones
```
public final List<String> availabilityZones()
```
    Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAvailabilityZones() to see if a value was sent in this field.
    
    Returns:
    
    Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
  - backupRetentionPeriod
```
public final 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 final 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 final 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 final 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 final 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 final 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 final String status()
```
    Specifies the current state of this DB cluster.
    
    Returns:
    
    Specifies the current state of this DB cluster.
  - percentProgress
```
public final String percentProgress()
```
    Specifies the progress of the operation as a percentage.
    
    Returns:
    
    Specifies the progress of the operation as a percentage.
  - earliestRestorableTime
```
public final 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 final 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 final 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.
  - hasCustomEndpoints
```
public final boolean hasCustomEndpoints()
```
    Returns true if the CustomEndpoints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - customEndpoints
```
public final 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.
    
    You can use hasCustomEndpoints() to see if a value was sent in this field.
    
    Returns:
    
    Identifies all custom endpoints associated with the cluster.
  - multiAZ
```
public final 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 final String engine()
```
    The name of the database engine to be used for this DB cluster.
    
    Returns:
    
    The name of the database engine to be used for this DB cluster.
  - engineVersion
```
public final String engineVersion()
```
    Indicates the database engine version.
    
    Returns:
    
    Indicates the database engine version.
  - latestRestorableTime
```
public final 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 final 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 final String masterUsername()
```
    Contains the master username for the DB cluster.
    
    Returns:
    
    Contains the master username for the DB cluster.
  - hasDbClusterOptionGroupMemberships
```
public final boolean hasDbClusterOptionGroupMemberships()
```
    Returns true if the DBClusterOptionGroupMemberships property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - dbClusterOptionGroupMemberships
```
public final 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.
    
    You can use hasDbClusterOptionGroupMemberships() to see if a value was sent in this field.
    
    Returns:
    
    Provides the list of option group memberships for this DB cluster.
  - preferredBackupWindow
```
public final 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 final 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 final 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.
  - hasReadReplicaIdentifiers
```
public final boolean hasReadReplicaIdentifiers()
```
    Returns true if the ReadReplicaIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - readReplicaIdentifiers
```
public final 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.
    
    You can use hasReadReplicaIdentifiers() to see if a value was sent in this field.
    
    Returns:
    
    Contains one or more identifiers of the read replicas associated with this DB cluster.
  - hasDbClusterMembers
```
public final boolean hasDbClusterMembers()
```
    Returns true if the DBClusterMembers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - dbClusterMembers
```
public final 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.
    
    You can use hasDbClusterMembers() to see if a value was sent in this field.
    
    Returns:
    
    Provides the list of instances that make up the DB cluster.
  - hasVpcSecurityGroups
```
public final boolean hasVpcSecurityGroups()
```
    Returns true if the VpcSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - vpcSecurityGroups
```
public final 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.
    
    You can use hasVpcSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    Provides a list of VPC security groups that the DB cluster belongs to.
  - hostedZoneId
```
public final 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 final Boolean storageEncrypted()
```
    Specifies whether the DB cluster is encrypted.
    
    Returns:
    
    Specifies whether the DB cluster is encrypted.
  - kmsKeyId
```
public final String kmsKeyId()
```
    If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
    
    Returns:
    
    If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
  - dbClusterResourceId
```
public final 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 CMK 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 CMK for the DB cluster is accessed.
  - dbClusterArn
```
public final String dbClusterArn()
```
    The Amazon Resource Name (ARN) for the DB cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - hasAssociatedRoles
```
public final boolean hasAssociatedRoles()
```
    Returns true if the AssociatedRoles property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - associatedRoles
```
public final 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.
    
    You can use hasAssociatedRoles() to see if a value was sent in this field.
    
    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 final Boolean iamDatabaseAuthenticationEnabled()
```
    A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
    
    Returns:
    
    A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
  - cloneGroupId
```
public final 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 final 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 final 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 final 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 final Long backtrackConsumedChangeRecords()
```
    The number of change records stored for Backtrack.
    
    Returns:
    
    The number of change records stored for Backtrack.
  - hasEnabledCloudwatchLogsExports
```
public final boolean hasEnabledCloudwatchLogsExports()
```
    Returns true if the EnabledCloudwatchLogsExports property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - enabledCloudwatchLogsExports
```
public final 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.
    
    You can use hasEnabledCloudwatchLogsExports() to see if a value was sent in this field.
    
    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 final Integer capacity()
```
    The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    
    Returns:
    
    The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
  - engineMode
```
public final String engineMode()
```
    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
    
    For more information, see CreateDBCluster.
    
    Returns:
    
    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
    
    For more information, see CreateDBCluster.
  - scalingConfigurationInfo
```
public final ScalingConfigurationInfo scalingConfigurationInfo()
```
    Returns the value of the ScalingConfigurationInfo property for this object.
    
    Returns:
    
    The value of the ScalingConfigurationInfo property for this object.
  - deletionProtection
```
public final Boolean deletionProtection()
```
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
    
    Returns:
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
  - httpEndpointEnabled
```
public final Boolean httpEndpointEnabled()
```
    A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
    
    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, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
    
    Returns:
    
    A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
    
    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, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
  - activityStreamMode
```
public final ActivityStreamMode activityStreamMode()
```
    The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamMode will return ActivityStreamMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamModeAsString().
    
    Returns:
    
    The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
    
    See Also:
    
    ActivityStreamMode
  - activityStreamModeAsString
```
public final String activityStreamModeAsString()
```
    The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamMode will return ActivityStreamMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamModeAsString().
    
    Returns:
    
    The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
    
    See Also:
    
    ActivityStreamMode
  - activityStreamStatus
```
public final ActivityStreamStatus activityStreamStatus()
```
    The status of the database activity stream.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamStatus will return ActivityStreamStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamStatusAsString().
    
    Returns:
    
    The status of the database activity stream.
    
    See Also:
    
    ActivityStreamStatus
  - activityStreamStatusAsString
```
public final String activityStreamStatusAsString()
```
    The status of the database activity stream.
    
    If the service returns an enum value that is not available in the current SDK version, activityStreamStatus will return ActivityStreamStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStreamStatusAsString().
    
    Returns:
    
    The status of the database activity stream.
    
    See Also:
    
    ActivityStreamStatus
  - activityStreamKmsKeyId
```
public final String activityStreamKmsKeyId()
```
    The AWS KMS key identifier used for encrypting messages in the database activity stream.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
    
    Returns:
    
    The AWS KMS key identifier used for encrypting messages in the database activity stream.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
  - activityStreamKinesisStreamName
```
public final String activityStreamKinesisStreamName()
```
    The name of the Amazon Kinesis data stream used for the database activity stream.
    
    Returns:
    
    The name of the Amazon Kinesis data stream used for the database activity stream.
  - copyTagsToSnapshot
```
public final Boolean copyTagsToSnapshot()
```
    Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
    
    Returns:
    
    Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
  - crossAccountClone
```
public final Boolean crossAccountClone()
```
    Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.
    
    Returns:
    
    Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.
  - hasDomainMemberships
```
public final boolean hasDomainMemberships()
```
    Returns true if the DomainMemberships property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - domainMemberships
```
public final List<DomainMembership> domainMemberships()
```
    The Active Directory Domain membership records associated with the DB cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDomainMemberships() to see if a value was sent in this field.
    
    Returns:
    
    The Active Directory Domain membership records associated with the DB cluster.
  - hasTagList
```
public final boolean hasTagList()
```
    Returns true if the TagList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tagList
```
public final List<Tag> tagList()
```
    Returns the value of the TagList property for this object.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTagList() to see if a value was sent in this field.
    
    Returns:
    
    The value of the TagList property for this object.
  - globalWriteForwardingStatus
```
public final WriteForwardingStatus globalWriteForwardingStatus()
```
    Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
    
    If the service returns an enum value that is not available in the current SDK version, globalWriteForwardingStatus will return WriteForwardingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from globalWriteForwardingStatusAsString().
    
    Returns:
    
    Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
    
    See Also:
    
    WriteForwardingStatus
  - globalWriteForwardingStatusAsString
```
public final String globalWriteForwardingStatusAsString()
```
    Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
    
    If the service returns an enum value that is not available in the current SDK version, globalWriteForwardingStatus will return WriteForwardingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from globalWriteForwardingStatusAsString().
    
    Returns:
    
    Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
    
    See Also:
    
    WriteForwardingStatus
  - globalWriteForwardingRequested
```
public final Boolean globalWriteForwardingRequested()
```
    Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
    
    Returns:
    
    Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
  - pendingModifiedValues
```
public final ClusterPendingModifiedValues pendingModifiedValues()
```
    A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
    
    Returns:
    
    A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
  - toBuilder
```
public DBCluster.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DBCluster.Builder,DBCluster>
  - builder
```
public static DBCluster.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBCluster.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasAvailabilityZones

availabilityZones

backupRetentionPeriod

characterSetName

databaseName

dbClusterIdentifier

dbClusterParameterGroup

dbSubnetGroup

status

percentProgress

earliestRestorableTime

endpoint

readerEndpoint

hasCustomEndpoints

customEndpoints

multiAZ

engine

engineVersion

latestRestorableTime

port

masterUsername

hasDbClusterOptionGroupMemberships

dbClusterOptionGroupMemberships

preferredBackupWindow

preferredMaintenanceWindow

replicationSourceIdentifier

hasReadReplicaIdentifiers

readReplicaIdentifiers

hasDbClusterMembers

dbClusterMembers

hasVpcSecurityGroups

vpcSecurityGroups

hostedZoneId

storageEncrypted

kmsKeyId

dbClusterResourceId

dbClusterArn

hasAssociatedRoles

associatedRoles

iamDatabaseAuthenticationEnabled

cloneGroupId

clusterCreateTime

earliestBacktrackTime

backtrackWindow

backtrackConsumedChangeRecords

hasEnabledCloudwatchLogsExports

enabledCloudwatchLogsExports

capacity

engineMode

scalingConfigurationInfo

deletionProtection

httpEndpointEnabled

activityStreamMode

activityStreamModeAsString

activityStreamStatus

activityStreamStatusAsString

activityStreamKmsKeyId

activityStreamKinesisStreamName

copyTagsToSnapshot

crossAccountClone

hasDomainMemberships

domainMemberships

hasTagList

tagList

globalWriteForwardingStatus

globalWriteForwardingStatusAsString

globalWriteForwardingRequested

pendingModifiedValues

toBuilder

builder

serializableBuilderClass

hashCode

equals