public static interface ModifyDbClusterRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>
| Modifier and Type | Method and Description |
|---|---|
ModifyDbClusterRequest.Builder |
allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
A value that indicates whether major version upgrades are allowed.
|
ModifyDbClusterRequest.Builder |
applyImmediately(Boolean applyImmediately)
A value that indicates 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 |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the 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 |
dbInstanceParameterGroupName(String dbInstanceParameterGroupName)
The name of the DB parameter group to apply to all instances of the DB cluster.
|
ModifyDbClusterRequest.Builder |
deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
ModifyDbClusterRequest.Builder |
domain(String domain)
The Active Directory directory ID to move the DB cluster to.
|
ModifyDbClusterRequest.Builder |
domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
ModifyDbClusterRequest.Builder |
enableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster
of an Aurora global database (GlobalCluster).
|
ModifyDbClusterRequest.Builder |
enableHttpEndpoint(Boolean enableHttpEndpoint)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
ModifyDbClusterRequest.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
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) |
ModifyDbClusterRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildModifyDbClusterRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
dbClusterIdentifier - The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
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
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
ModifyDbClusterRequest.Builder applyImmediately(Boolean applyImmediately)
A value that indicates 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.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication,
MasterUserPassword, and NewDBClusterIdentifier values. If the
ApplyImmediately parameter is disabled, 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.
By default, this parameter is disabled.
applyImmediately - A value that indicates 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.
The ApplyImmediately parameter only affects the
EnableIAMDatabaseAuthentication, MasterUserPassword, and
NewDBClusterIdentifier values. If the ApplyImmediately parameter is
disabled, 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.
By default, this parameter is disabled.
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
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
ModifyDbClusterRequest.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
dbClusterParameterGroupName - The name of the DB cluster parameter group to use for the DB cluster.ModifyDbClusterRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the DB cluster will belong to.
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.
vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.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.
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.
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.
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.
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 is enabled 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.
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 is enabled 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.
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.
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.
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.
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.
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 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.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
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 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.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
ModifyDbClusterRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication - A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
ModifyDbClusterRequest.Builder backtrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
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.
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.
This is a convenience that creates an instance of theCloudwatchLogsExportConfiguration.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).cloudwatchLogsExportConfiguration - a consumer that will call methods on CloudwatchLogsExportConfiguration.BuildercloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration)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.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use
the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora),
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"
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.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible
Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible
Aurora), 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"
ModifyDbClusterRequest.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
A value that indicates whether major version upgrades are allowed.
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.
allowMajorVersionUpgrade - A value that indicates whether major version upgrades are allowed.
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.
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 aren't applied during the next maintenance
window but instead are applied immediately.
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 only valid in combination with the
AllowMajorVersionUpgrade parameter.
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 aren't applied during the next
maintenance window but instead are applied immediately.
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 only valid in combination with the
AllowMajorVersionUpgrade parameter.
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.
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.
ModifyDbClusterRequest.Builder domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.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.
scalingConfiguration - The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless DB engine mode.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.
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).scalingConfiguration - a consumer that will call methods on ScalingConfiguration.BuilderscalingConfiguration(ScalingConfiguration)ModifyDbClusterRequest.Builder deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled.ModifyDbClusterRequest.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)
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, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
enableHttpEndpoint - 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, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
ModifyDbClusterRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
copyTagsToSnapshot - A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
The default is not to copy them.ModifyDbClusterRequest.Builder enableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
enableGlobalWriteForwarding - A value that indicates whether to enable this DB cluster to forward write operations to the primary
cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
ModifyDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderModifyDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.