DBCluster.Builder (AWS SDK for Java

All Superinterfaces:

Buildable, CopyableBuilder<DBCluster.Builder,DBCluster>, SdkBuilder<DBCluster.Builder,DBCluster>, SdkPojo

Enclosing class:

DBCluster
```
public static interface DBCluster.Builder
extends SdkPojo, CopyableBuilder<DBCluster.Builder,DBCluster>
```

Method Summary

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

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - allocatedStorage
```
DBCluster.Builder allocatedStorage(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - availabilityZones
```
DBCluster.Builder availabilityZones(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.
  - availabilityZones
```
DBCluster.Builder availabilityZones(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.
  - backupRetentionPeriod
```
DBCluster.Builder backupRetentionPeriod(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.
  - characterSetName
```
DBCluster.Builder characterSetName(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.
  - databaseName
```
DBCluster.Builder databaseName(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.
  - dbClusterIdentifier
```
DBCluster.Builder dbClusterIdentifier(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.
  - dbClusterParameterGroup
```
DBCluster.Builder dbClusterParameterGroup(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.
  - dbSubnetGroup
```
DBCluster.Builder dbSubnetGroup(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.
  - status
```
DBCluster.Builder status(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.
  - percentProgress
```
DBCluster.Builder percentProgress(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.
  - earliestRestorableTime
```
DBCluster.Builder earliestRestorableTime(Instant earliestRestorableTime)
```
    The earliest time to which a database can be restored with point-in-time restore.
    
    Parameters:
    
    earliestRestorableTime - 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.
  - endpoint
```
DBCluster.Builder endpoint(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.
  - readerEndpoint
```
DBCluster.Builder readerEndpoint(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - customEndpoints
```
DBCluster.Builder customEndpoints(Collection<String> customEndpoints)
```
    Identifies all custom endpoints associated with the cluster.
    
    Parameters:
    
    customEndpoints - Identifies all custom endpoints associated with the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - customEndpoints
```
DBCluster.Builder customEndpoints(String... customEndpoints)
```
    Identifies all custom endpoints associated with the cluster.
    
    Parameters:
    
    customEndpoints - Identifies all custom endpoints associated with the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - multiAZ
```
DBCluster.Builder multiAZ(Boolean multiAZ)
```
    Specifies whether the DB cluster has instances in multiple Availability Zones.
    
    Parameters:
    
    multiAZ - Specifies whether the DB cluster has instances in multiple Availability Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engine
```
DBCluster.Builder engine(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.
  - engineVersion
```
DBCluster.Builder engineVersion(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.
  - latestRestorableTime
```
DBCluster.Builder latestRestorableTime(Instant 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.
  - port
```
DBCluster.Builder port(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.
  - masterUsername
```
DBCluster.Builder masterUsername(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.
  - dbClusterOptionGroupMemberships
```
DBCluster.Builder dbClusterOptionGroupMemberships(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.
  - dbClusterOptionGroupMemberships
```
DBCluster.Builder dbClusterOptionGroupMemberships(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.
  - dbClusterOptionGroupMemberships
```
DBCluster.Builder dbClusterOptionGroupMemberships(Consumer<DBClusterOptionGroupStatus.Builder>... dbClusterOptionGroupMemberships)
```
    Provides the list of option group memberships for this DB cluster.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #dbClusterOptionGroupMemberships(List).
    
    Parameters:
    
    dbClusterOptionGroupMemberships - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #dbClusterOptionGroupMemberships(List)
  - preferredBackupWindow
```
DBCluster.Builder preferredBackupWindow(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.
  - preferredMaintenanceWindow
```
DBCluster.Builder preferredMaintenanceWindow(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.
  - replicationSourceIdentifier
```
DBCluster.Builder replicationSourceIdentifier(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.
  - readReplicaIdentifiers
```
DBCluster.Builder readReplicaIdentifiers(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.
  - readReplicaIdentifiers
```
DBCluster.Builder readReplicaIdentifiers(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.
  - dbClusterMembers
```
DBCluster.Builder dbClusterMembers(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.
  - dbClusterMembers
```
DBCluster.Builder dbClusterMembers(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.
  - dbClusterMembers
```
DBCluster.Builder dbClusterMembers(Consumer<DBClusterMember.Builder>... dbClusterMembers)
```
    Provides the list of instances that make up the DB cluster.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #dbClusterMembers(List).
    
    Parameters:
    
    dbClusterMembers - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #dbClusterMembers(List)
  - vpcSecurityGroups
```
DBCluster.Builder vpcSecurityGroups(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.
  - vpcSecurityGroups
```
DBCluster.Builder vpcSecurityGroups(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.
  - vpcSecurityGroups
```
DBCluster.Builder vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
```
    Provides a list of VPC security groups that the DB cluster belongs to.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #vpcSecurityGroups(List).
    
    Parameters:
    
    vpcSecurityGroups - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #vpcSecurityGroups(List)
  - hostedZoneId
```
DBCluster.Builder hostedZoneId(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.
  - storageEncrypted
```
DBCluster.Builder storageEncrypted(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.
  - kmsKeyId
```
DBCluster.Builder kmsKeyId(String kmsKeyId)
```
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbClusterResourceId
```
DBCluster.Builder dbClusterResourceId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbClusterArn
```
DBCluster.Builder dbClusterArn(String dbClusterArn)
```
    The Amazon Resource Name (ARN) for the DB cluster.
    
    Parameters:
    
    dbClusterArn - The Amazon Resource Name (ARN) for the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - associatedRoles
```
DBCluster.Builder associatedRoles(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - associatedRoles
```
DBCluster.Builder associatedRoles(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - associatedRoles
```
DBCluster.Builder associatedRoles(Consumer<DBClusterRole.Builder>... 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.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #associatedRoles(List).
    
    Parameters:
    
    associatedRoles - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #associatedRoles(List)
  - iamDatabaseAuthenticationEnabled
```
DBCluster.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
```
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    Parameters:
    
    iamDatabaseAuthenticationEnabled - True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cloneGroupId
```
DBCluster.Builder cloneGroupId(String cloneGroupId)
```
    Identifies the clone group to which the DB cluster is associated.
    
    Parameters:
    
    cloneGroupId - Identifies the clone group to which the DB cluster is associated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - clusterCreateTime
```
DBCluster.Builder clusterCreateTime(Instant clusterCreateTime)
```
    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
    
    Parameters:
    
    clusterCreateTime - Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - earliestBacktrackTime
```
DBCluster.Builder earliestBacktrackTime(Instant earliestBacktrackTime)
```
    The earliest time to which a DB cluster can be backtracked.
    
    Parameters:
    
    earliestBacktrackTime - The earliest time to which a DB cluster can be backtracked.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - backtrackWindow
```
DBCluster.Builder backtrackWindow(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - backtrackConsumedChangeRecords
```
DBCluster.Builder backtrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
```
    The number of change records stored for Backtrack.
    
    Parameters:
    
    backtrackConsumedChangeRecords - The number of change records stored for Backtrack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enabledCloudwatchLogsExports
```
DBCluster.Builder enabledCloudwatchLogsExports(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enabledCloudwatchLogsExports
```
DBCluster.Builder enabledCloudwatchLogsExports(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capacity
```
DBCluster.Builder capacity(Integer capacity)
```
    Sets the value of the Capacity property for this object.
    
    Parameters:
    
    capacity - The new value for the Capacity property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineMode
```
DBCluster.Builder engineMode(String engineMode)
```
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
    
    Parameters:
    
    engineMode - The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - scalingConfigurationInfo
```
DBCluster.Builder scalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo)
```
    Sets the value of the ScalingConfigurationInfo property for this object.
    
    Parameters:
    
    scalingConfigurationInfo - The new value for the ScalingConfigurationInfo property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - scalingConfigurationInfo
```
default DBCluster.Builder scalingConfigurationInfo(Consumer<ScalingConfigurationInfo.Builder> scalingConfigurationInfo)
```
    Sets the value of the ScalingConfigurationInfo property for this object. This is a convenience that creates an instance of the ScalingConfigurationInfo.Builder avoiding the need to create one manually via ScalingConfigurationInfo.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfigurationInfo(ScalingConfigurationInfo).
    
    Parameters:
    
    scalingConfigurationInfo - a consumer that will call methods on ScalingConfigurationInfo.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    scalingConfigurationInfo(ScalingConfigurationInfo)
  - deletionProtection
```
DBCluster.Builder deletionProtection(Boolean deletionProtection)
```
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
    
    Parameters:
    
    deletionProtection - Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - httpEndpointEnabled
```
DBCluster.Builder httpEndpointEnabled(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.

Interface DBCluster.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

allocatedStorage

availabilityZones

availabilityZones

backupRetentionPeriod

characterSetName

databaseName

dbClusterIdentifier

dbClusterParameterGroup

dbSubnetGroup

status

percentProgress

earliestRestorableTime

endpoint

readerEndpoint

customEndpoints

customEndpoints

multiAZ

engine

engineVersion

latestRestorableTime

port

masterUsername

dbClusterOptionGroupMemberships

dbClusterOptionGroupMemberships

dbClusterOptionGroupMemberships

preferredBackupWindow

preferredMaintenanceWindow

replicationSourceIdentifier

readReplicaIdentifiers

readReplicaIdentifiers

dbClusterMembers

dbClusterMembers

dbClusterMembers

vpcSecurityGroups

vpcSecurityGroups

vpcSecurityGroups

hostedZoneId

storageEncrypted

kmsKeyId

dbClusterResourceId

dbClusterArn

associatedRoles

associatedRoles

associatedRoles

iamDatabaseAuthenticationEnabled

cloneGroupId

clusterCreateTime

earliestBacktrackTime

backtrackWindow

backtrackConsumedChangeRecords

enabledCloudwatchLogsExports

enabledCloudwatchLogsExports

capacity

engineMode

scalingConfigurationInfo

scalingConfigurationInfo

deletionProtection

httpEndpointEnabled