software.amazon.awssdk.services.rds.model

Interface ModifyDbClusterRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>, RdsRequest.Builder, SdkBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyDbClusterRequest

public static interface ModifyDbClusterRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>

Method Summary

Modifier and Type	Method and Description
ModifyDbClusterRequest.Builder	applyImmediately(Boolean applyImmediately) A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster.
ModifyDbClusterRequest.Builder	backtrackWindow(Long backtrackWindow) The target backtrack window, in seconds.
ModifyDbClusterRequest.Builder	backupRetentionPeriod(Integer backupRetentionPeriod) The number of days for which automated backups are retained.
ModifyDbClusterRequest.Builder	cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration) The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
default ModifyDbClusterRequest.Builder	cloudwatchLogsExportConfiguration(Consumer<CloudwatchLogsExportConfiguration.Builder> cloudwatchLogsExportConfiguration) The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
ModifyDbClusterRequest.Builder	dbClusterIdentifier(String dbClusterIdentifier) The DB cluster identifier for the cluster being modified.
ModifyDbClusterRequest.Builder	dbClusterParameterGroupName(String dbClusterParameterGroupName) The name of the DB cluster parameter group to use for the DB cluster.
ModifyDbClusterRequest.Builder	deletionProtection(Boolean deletionProtection) Indicates if the DB cluster has deletion protection enabled.
ModifyDbClusterRequest.Builder	enableHttpEndpoint(Boolean enableHttpEndpoint)
ModifyDbClusterRequest.Builder	enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
ModifyDbClusterRequest.Builder	engineVersion(String engineVersion) The version number of the database engine to which you want to upgrade.
ModifyDbClusterRequest.Builder	masterUserPassword(String masterUserPassword) The new password for the master database user.
ModifyDbClusterRequest.Builder	newDBClusterIdentifier(String newDBClusterIdentifier) The new DB cluster identifier for the DB cluster when renaming a DB cluster.
ModifyDbClusterRequest.Builder	optionGroupName(String optionGroupName) A value that indicates that the DB cluster should be associated with the specified option group.
ModifyDbClusterRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ModifyDbClusterRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ModifyDbClusterRequest.Builder	port(Integer port) The port number on which the DB cluster accepts connections.
ModifyDbClusterRequest.Builder	preferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
ModifyDbClusterRequest.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
default ModifyDbClusterRequest.Builder	scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration) The scaling properties of the DB cluster.
ModifyDbClusterRequest.Builder	scalingConfiguration(ScalingConfiguration scalingConfiguration) The scaling properties of the DB cluster.
ModifyDbClusterRequest.Builder	vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the DB cluster will belong to.
ModifyDbClusterRequest.Builder	vpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of VPC security groups that the DB cluster will belong to.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

dbClusterIdentifier

ModifyDbClusterRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Parameters:

dbClusterIdentifier - The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

newDBClusterIdentifier

ModifyDbClusterRequest.Builder newDBClusterIdentifier(String newDBClusterIdentifier)

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens

• The first character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Parameters:

newDBClusterIdentifier - The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens

• The first character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Returns:

Returns a reference to this object so that method calls can be chained together.

applyImmediately

ModifyDbClusterRequest.Builder applyImmediately(Boolean applyImmediately)

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

Parameters:

applyImmediately - A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

Returns:

Returns a reference to this object so that method calls can be chained together.

backupRetentionPeriod

ModifyDbClusterRequest.Builder backupRetentionPeriod(Integer backupRetentionPeriod)

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35

Parameters:

backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35

Returns:

Returns a reference to this object so that method calls can be chained together.

dbClusterParameterGroupName

ModifyDbClusterRequest.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)

The name of the DB cluster parameter group to use for the DB cluster.

Parameters:

dbClusterParameterGroupName - The name of the DB cluster parameter group to use for the DB cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSecurityGroupIds

ModifyDbClusterRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

A list of VPC security groups that the DB cluster will belong to.

Parameters:

vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSecurityGroupIds

ModifyDbClusterRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

A list of VPC security groups that the DB cluster will belong to.

Parameters:

vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.

Returns:

Returns a reference to this object so that method calls can be chained together.

port

ModifyDbClusterRequest.Builder port(Integer port)

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Parameters:

port - The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

masterUserPassword

ModifyDbClusterRequest.Builder masterUserPassword(String masterUserPassword)

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

Parameters:

masterUserPassword - The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

optionGroupName

ModifyDbClusterRequest.Builder optionGroupName(String optionGroupName)

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Parameters:

optionGroupName - A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredBackupWindow

ModifyDbClusterRequest.Builder preferredBackupWindow(String preferredBackupWindow)

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredMaintenanceWindow

ModifyDbClusterRequest.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Parameters:

preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableIAMDatabaseAuthentication

ModifyDbClusterRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameters:

enableIAMDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

Returns a reference to this object so that method calls can be chained together.

backtrackWindow

ModifyDbClusterRequest.Builder backtrackWindow(Long backtrackWindow)

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Parameters:

backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudwatchLogsExportConfiguration

ModifyDbClusterRequest.Builder cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Parameters:

cloudwatchLogsExportConfiguration - The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudwatchLogsExportConfiguration

default ModifyDbClusterRequest.Builder cloudwatchLogsExportConfiguration(Consumer<CloudwatchLogsExportConfiguration.Builder> cloudwatchLogsExportConfiguration)

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

This is a convenience that creates an instance of the CloudwatchLogsExportConfiguration.Builder avoiding the need to create one manually via CloudwatchLogsExportConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration).

Parameters:

cloudwatchLogsExportConfiguration - a consumer that will call methods on CloudwatchLogsExportConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration)

engineVersion

ModifyDbClusterRequest.Builder engineVersion(String engineVersion)

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

Parameters:

engineVersion - The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

Returns:

Returns a reference to this object so that method calls can be chained together.

scalingConfiguration

ModifyDbClusterRequest.Builder scalingConfiguration(ScalingConfiguration scalingConfiguration)

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Parameters:

scalingConfiguration - The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

scalingConfiguration

default ModifyDbClusterRequest.Builder scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

This is a convenience that creates an instance of the ScalingConfiguration.Builder avoiding the need to create one manually via ScalingConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfiguration(ScalingConfiguration).

Parameters:

scalingConfiguration - a consumer that will call methods on ScalingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

scalingConfiguration(ScalingConfiguration)

deletionProtection

ModifyDbClusterRequest.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.

enableHttpEndpoint

ModifyDbClusterRequest.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

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:

enableHttpEndpoint -

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

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.

overrideConfiguration

ModifyDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ModifyDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.