public static interface ModifyDbClusterRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>
| Modifier and Type | Method and Description |
|---|---|
ModifyDbClusterRequest.Builder |
allocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
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 |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the
maintenance window.
|
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 |
dbClusterInstanceClass(String dbClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
|
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 v1 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 |
enablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to turn on Performance Insights for the DB cluster.
|
ModifyDbClusterRequest.Builder |
engineVersion(String engineVersion)
The version number of the database engine to which you want to upgrade.
|
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.
|
ModifyDbClusterRequest.Builder |
masterUserPassword(String masterUserPassword)
The new password for the master database user.
|
ModifyDbClusterRequest.Builder |
monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
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.
|
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 |
performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
ModifyDbClusterRequest.Builder |
performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
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 |
storageType(String storageType)
Specifies the storage type to be associated with 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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
Valid for: Aurora DB clusters only
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
Valid for: Aurora DB clusters only
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
ModifyDbClusterRequest.Builder backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
backupRetentionPeriod - The number of days for which automated backups are retained. Specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
ModifyDbClusterRequest.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
dbClusterParameterGroupName - The name of the DB cluster parameter group to use for the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
ModifyDbClusterRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
ModifyDbClusterRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters only
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.
Valid for: Aurora DB clusters only
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
ModifyDbClusterRequest.Builder optionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
optionGroupName - A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
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 isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
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).
Valid for: Aurora MySQL DB clusters only
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).
Valid for: Aurora MySQL DB clusters only
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. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
cloudwatchLogsExportConfiguration - The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific
DB cluster. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and
slowquery.
Aurora PostgreSQL
Possible value is postgresql.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 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 MySQL 5.7-compatible and MySQL 8.0-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"
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: Aurora DB clusters and Multi-AZ DB clusters
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 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 MySQL 5.7-compatible and MySQL 8.0-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"
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: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters only
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.
Valid for: Aurora DB clusters only
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.
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.
Valid for: Aurora DB clusters only
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.
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.
Valid for: Aurora DB clusters only
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: Aurora DB clusters only
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: Aurora DB clusters only
ModifyDbClusterRequest.Builder domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
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: Aurora DB clusters only
scalingConfiguration - The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless DB engine mode.
Valid for: Aurora DB clusters only
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: Aurora DB clusters only
This is a convenience that creates an instance of theScalingConfiguration.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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
ModifyDbClusterRequest.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
enableHttpEndpoint - A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters only
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.
Valid for: Aurora DB clusters only
ModifyDbClusterRequest.Builder dbClusterInstanceClass(String dbClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.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: Multi-AZ DB clusters only
dbClusterInstanceClass - The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6g.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: Multi-AZ DB clusters only
ModifyDbClusterRequest.Builder allocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Type: Integer
Valid for: Multi-AZ DB clusters only
allocatedStorage - The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB
cluster.
Type: Integer
Valid for: Multi-AZ DB clusters only
ModifyDbClusterRequest.Builder storageType(String storageType)
Specifies the storage type to be associated with the DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
storageType - Specifies the storage type to be associated with the DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
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 to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
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 to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
ModifyDbClusterRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates 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: Multi-AZ DB clusters only
autoMinorVersionUpgrade - A value that indicates 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: Multi-AZ DB clusters only
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. The default is 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other
than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
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. The default is 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
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: Multi-AZ DB clusters only
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: Multi-AZ DB clusters only
ModifyDbClusterRequest.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates 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: Multi-AZ DB clusters only
enablePerformanceInsights - A value that indicates 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: Multi-AZ DB clusters only
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: Multi-AZ DB clusters only
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: Multi-AZ DB clusters only
ModifyDbClusterRequest.Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
Valid for: Multi-AZ DB clusters only
performanceInsightsRetentionPeriod - The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2
years).
Valid for: Multi-AZ DB clusters only
ModifyDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderModifyDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.