Package 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 Details

    • dbClusterIdentifier

      ModifyDbClusterRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

      The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must match the identifier of an existing DB cluster.

      Parameters:
      dbClusterIdentifier - The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must match the identifier of an existing DB cluster.

      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.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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)

      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 disabled, changes to the DB cluster are applied during the next maintenance window.

      Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.

      By default, this parameter is disabled.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      applyImmediately - 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 disabled, changes to the DB cluster are applied during the next maintenance window.

      Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.

      By default, this parameter is disabled.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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. Specify a minimum value of 1.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Default: 1

      Constraints:

      • Must be a value from 1 to 35.

      Parameters:
      backupRetentionPeriod - The number of days for which automated backups are retained. Specify a minimum value of 1 .

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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 EC2 VPC security groups to associate with this DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

    • vpcSecurityGroupIds

      ModifyDbClusterRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

      A list of EC2 VPC security groups to associate with this DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for Cluster Type: Aurora DB clusters only

      Valid Values: 1150-65535

      Default: The same port as the original DB cluster.

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

      Valid for Cluster Type: Aurora DB clusters only

      Valid Values: 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.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must contain from 8 to 41 characters.

      • Can contain any printable ASCII character except "/", """, or "@".

      • Can't be specified if ManageMasterUserPassword is turned on.

      Parameters:
      masterUserPassword - The new password for the master database user.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must contain from 8 to 41 characters.

      • Can contain any printable ASCII character except "/", """, or "@".

      • Can't be specified if ManageMasterUserPassword is turned on.

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

    • optionGroupName

      ModifyDbClusterRequest.Builder optionGroupName(String optionGroupName)

      The option group to associate the DB cluster with.

      DB clusters are associated with a default option group that can't be modified.

      Parameters:
      optionGroupName - The option group to associate the DB cluster with.

      DB clusters are associated with a default option group that can't be modified.

      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 Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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 Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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.

      Constraints:

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

      • Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

      • Must be in Universal Coordinated Time (UTC).

      • Must be at least 30 minutes.

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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.

      Constraints:

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

      • Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

      • Must be in Universal Coordinated Time (UTC).

      • Must be at least 30 minutes.

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

    • enableIAMDatabaseAuthentication

      ModifyDbClusterRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

      Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Parameters:
      enableIAMDatabaseAuthentication - Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      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.

      Valid for Cluster Type: Aurora MySQL DB clusters only

      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 .

      Valid for Cluster Type: Aurora MySQL DB clusters only

      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.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      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.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      This is a convenience method 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:

    • 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 ApplyImmediately is enabled.

      If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.

      To list all of the available engine versions for Aurora MySQL, use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for Aurora PostgreSQL, use the following command:

      aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for RDS for MySQL, use the following command:

      aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for RDS for PostgreSQL, use the following command:

      aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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 ApplyImmediately is enabled.

      If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.

      To list all of the available engine versions for Aurora MySQL, use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for Aurora PostgreSQL, use the following command:

      aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for RDS for MySQL, use the following command:

      aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for RDS for PostgreSQL, use the following command:

      aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

    • allowMajorVersionUpgrade

      ModifyDbClusterRequest.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

      Specifies whether major version upgrades are allowed.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

      Parameters:
      allowMajorVersionUpgrade - Specifies whether major version upgrades are allowed.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

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

    • dbInstanceParameterGroupName

      ModifyDbClusterRequest.Builder dbInstanceParameterGroupName(String dbInstanceParameterGroupName)

      The name of the DB parameter group to apply to all instances of the DB cluster.

      When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.

      Valid for Cluster Type: Aurora DB clusters only

      Default: The existing name setting

      Constraints:

      • The DB parameter group must be in the same DB parameter group family as this DB cluster.

      • The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.

      Parameters:
      dbInstanceParameterGroupName - The name of the DB parameter group to apply to all instances of the DB cluster.

      When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.

      Valid for Cluster Type: Aurora DB clusters only

      Default: The existing name setting

      Constraints:

      • The DB parameter group must be in the same DB parameter group family as this DB cluster.

      • The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.

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

    • domain

      ModifyDbClusterRequest.Builder domain(String domain)

      The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

      For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Parameters:
      domain - The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

      For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

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

    • domainIAMRoleName

      ModifyDbClusterRequest.Builder domainIAMRoleName(String domainIAMRoleName)

      The name of the IAM role to use when making API calls to the Directory Service.

      Valid for Cluster Type: Aurora DB clusters only

      Parameters:
      domainIAMRoleName - The name of the IAM role to use when making API calls to the Directory Service.

      Valid for Cluster Type: Aurora DB clusters only

      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.

      Valid for Cluster Type: Aurora DB clusters only

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

      Valid for Cluster Type: Aurora DB clusters only

      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.

      Valid for Cluster Type: Aurora DB clusters only

      This is a convenience method 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:

    • deletionProtection

      ModifyDbClusterRequest.Builder deletionProtection(Boolean deletionProtection)

      Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      deletionProtection - Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

    • enableHttpEndpoint

      ModifyDbClusterRequest.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)

      Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.

      When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

      For more information, see Using RDS Data API in the Amazon Aurora User Guide.

      This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.

      Valid for Cluster Type: Aurora DB clusters only

      Parameters:
      enableHttpEndpoint - Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.

      When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

      For more information, see Using RDS Data API in the Amazon Aurora User Guide.

      This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.

      Valid for Cluster Type: Aurora DB clusters only

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

    • copyTagsToSnapshot

      ModifyDbClusterRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

      Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      copyTagsToSnapshot - Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

    • enableGlobalWriteForwarding

      ModifyDbClusterRequest.Builder enableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)

      Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

      You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.

      Valid for Cluster Type: Aurora DB clusters only

      Parameters:
      enableGlobalWriteForwarding - Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

      You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.

      Valid for Cluster Type: Aurora DB clusters only

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

    • dbClusterInstanceClass

      ModifyDbClusterRequest.Builder dbClusterInstanceClass(String dbClusterInstanceClass)

      The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

      For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Parameters:
      dbClusterInstanceClass - The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

      For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

      Valid for Cluster Type: Multi-AZ DB clusters only

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

    • allocatedStorage

      ModifyDbClusterRequest.Builder allocatedStorage(Integer allocatedStorage)

      The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Parameters:
      allocatedStorage - The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

      Valid for Cluster Type: Multi-AZ DB clusters only

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

    • storageType

      ModifyDbClusterRequest.Builder storageType(String storageType)

      The storage type to associate with the DB cluster.

      For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.

      When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Valid Values:

      • Aurora DB clusters - aurora | aurora-iopt1

      • Multi-AZ DB clusters - io1 | io2 | gp3

      Default:

      • Aurora DB clusters - aurora

      • Multi-AZ DB clusters - io1

      Parameters:
      storageType - The storage type to associate with the DB cluster.

      For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.

      When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Valid Values:

      • Aurora DB clusters - aurora | aurora-iopt1

      • Multi-AZ DB clusters - io1 | io2 | gp3

      Default:

      • Aurora DB clusters - aurora

      • Multi-AZ DB clusters - io1

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

    • iops

      ModifyDbClusterRequest.Builder iops(Integer iops)

      The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

      For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Constraints:

      • Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

      Parameters:
      iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

      For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Constraints:

      • Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

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

    • autoMinorVersionUpgrade

      ModifyDbClusterRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

      Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Parameters:
      autoMinorVersionUpgrade - Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

      Valid for Cluster Type: Multi-AZ DB clusters only

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

    • monitoringInterval

      ModifyDbClusterRequest.Builder monitoringInterval(Integer monitoringInterval)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.

      If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

      Default: 0

      Parameters:
      monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.

      If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

      Default: 0

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

    • monitoringRoleArn

      ModifyDbClusterRequest.Builder monitoringRoleArn(String monitoringRoleArn)

      The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

      If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Parameters:
      monitoringRoleArn - The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

      If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

      Valid for Cluster Type: Multi-AZ DB clusters only

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

    • enablePerformanceInsights

      ModifyDbClusterRequest.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)

      Specifies whether to turn on Performance Insights for the DB cluster.

      For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Parameters:
      enablePerformanceInsights - Specifies whether to turn on Performance Insights for the DB cluster.

      For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

      Valid for Cluster Type: Multi-AZ DB clusters only

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

    • performanceInsightsKMSKeyId

      ModifyDbClusterRequest.Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)

      The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

      If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Parameters:
      performanceInsightsKMSKeyId - The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

      If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

      Valid for Cluster Type: Multi-AZ DB clusters only

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

    • performanceInsightsRetentionPeriod

      ModifyDbClusterRequest.Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)

      The number of days to retain Performance Insights data.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Valid Values:

      • 7

      • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

      • 731

      Default: 7 days

      If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

      Parameters:
      performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Valid Values:

      • 7

      • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

      • 731

      Default: 7 days

      If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

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

    • serverlessV2ScalingConfiguration

      ModifyDbClusterRequest.Builder serverlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
      Sets the value of the ServerlessV2ScalingConfiguration property for this object.
      Parameters:
      serverlessV2ScalingConfiguration - The new value for the ServerlessV2ScalingConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverlessV2ScalingConfiguration

      default ModifyDbClusterRequest.Builder serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfiguration.Builder> serverlessV2ScalingConfiguration)
      Sets the value of the ServerlessV2ScalingConfiguration property for this object. This is a convenience method that creates an instance of the ServerlessV2ScalingConfiguration.Builder avoiding the need to create one manually via ServerlessV2ScalingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serverlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration).

      Parameters:
      serverlessV2ScalingConfiguration - a consumer that will call methods on ServerlessV2ScalingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • networkType

      ModifyDbClusterRequest.Builder networkType(String networkType)

      The network type of the DB cluster.

      The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Valid Values: IPV4 | DUAL

      Parameters:
      networkType - The network type of the DB cluster.

      The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Valid Values: IPV4 | DUAL

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

    • manageMasterUserPassword

      ModifyDbClusterRequest.Builder manageMasterUserPassword(Boolean manageMasterUserPassword)

      Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

      If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.

      If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      manageMasterUserPassword - Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

      If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.

      If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

    • rotateMasterUserPassword

      ModifyDbClusterRequest.Builder rotateMasterUserPassword(Boolean rotateMasterUserPassword)

      Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

      This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • You must apply the change immediately when rotating the master user password.

      Parameters:
      rotateMasterUserPassword - Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

      This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • You must apply the change immediately when rotating the master user password.

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

    • masterUserSecretKmsKeyId

      ModifyDbClusterRequest.Builder masterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)

      The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

      This setting is valid only if both of the following conditions are met:

      • The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.

        If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.

      • You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.

        If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      masterUserSecretKmsKeyId - The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

      This setting is valid only if both of the following conditions are met:

      • The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.

        If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.

      • You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.

        If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

    • engineMode

      ModifyDbClusterRequest.Builder engineMode(String engineMode)

      The DB engine mode of the DB cluster, either provisioned or serverless.

      The DB engine mode can be modified only from serverless to provisioned.

      For more information, see CreateDBCluster.

      Valid for Cluster Type: Aurora DB clusters only

      Parameters:
      engineMode - The DB engine mode of the DB cluster, either provisioned or serverless.

      The DB engine mode can be modified only from serverless to provisioned.

      For more information, see CreateDBCluster.

      Valid for Cluster Type: Aurora DB clusters only

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

    • allowEngineModeChange

      ModifyDbClusterRequest.Builder allowEngineModeChange(Boolean allowEngineModeChange)

      Specifies whether engine mode changes from serverless to provisioned are allowed.

      Valid for Cluster Type: Aurora Serverless v1 DB clusters only

      Constraints:

      • You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.

      Parameters:
      allowEngineModeChange - Specifies whether engine mode changes from serverless to provisioned are allowed.

      Valid for Cluster Type: Aurora Serverless v1 DB clusters only

      Constraints:

      • You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.

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

    • enableLocalWriteForwarding

      ModifyDbClusterRequest.Builder enableLocalWriteForwarding(Boolean enableLocalWriteForwarding)

      Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

      Valid for: Aurora DB clusters only

      Parameters:
      enableLocalWriteForwarding - Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

      Valid for: Aurora DB clusters only

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

    • awsBackupRecoveryPointArn

      ModifyDbClusterRequest.Builder awsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)

      The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

      Parameters:
      awsBackupRecoveryPointArn - The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableLimitlessDatabase

      ModifyDbClusterRequest.Builder enableLimitlessDatabase(Boolean enableLimitlessDatabase)

      Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

      Valid for: Aurora DB clusters only

      Parameters:
      enableLimitlessDatabase - Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

      Valid for: Aurora DB clusters only

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

    • caCertificateIdentifier

      ModifyDbClusterRequest.Builder caCertificateIdentifier(String caCertificateIdentifier)

      The CA certificate identifier to use for the DB cluster's server certificate.

      For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.

      Valid for Cluster Type: Multi-AZ DB clusters

      Parameters:
      caCertificateIdentifier - The CA certificate identifier to use for the DB cluster's server certificate.

      For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.

      Valid for Cluster Type: Multi-AZ DB clusters

      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.