public static interface ModifyDbClusterRequest.Builder extends NeptuneRequest.Builder, SdkPojo, CopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>
| Modifier and Type | Method and Description |
|---|---|
ModifyDbClusterRequest.Builder |
applyImmediately(Boolean applyImmediately)
A value that specifies whether the modifications in this request and any pending modifications are
asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow setting
for the DB cluster. |
ModifyDbClusterRequest.Builder |
backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
ModifyDbClusterRequest.Builder |
cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
cluster.
|
default ModifyDbClusterRequest.Builder |
cloudwatchLogsExportConfiguration(Consumer<CloudwatchLogsExportConfiguration.Builder> cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
cluster.
|
ModifyDbClusterRequest.Builder |
dbClusterIdentifier(String dbClusterIdentifier)
The DB cluster identifier for the cluster being modified.
|
ModifyDbClusterRequest.Builder |
dbClusterParameterGroupName(String dbClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
|
ModifyDbClusterRequest.Builder |
deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
ModifyDbClusterRequest.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
ModifyDbClusterRequest.Builder |
engineVersion(String engineVersion)
The version number of the database engine to which you want to upgrade.
|
ModifyDbClusterRequest.Builder |
masterUserPassword(String masterUserPassword)
The new password for the master database user.
|
ModifyDbClusterRequest.Builder |
newDBClusterIdentifier(String newDBClusterIdentifier)
The new DB cluster identifier for the DB cluster when renaming a DB cluster.
|
ModifyDbClusterRequest.Builder |
optionGroupName(String optionGroupName)
(Not supported by Neptune)
|
ModifyDbClusterRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ModifyDbClusterRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ModifyDbClusterRequest.Builder |
port(Integer port)
The port number on which the DB cluster accepts connections.
|
ModifyDbClusterRequest.Builder |
preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
ModifyDbClusterRequest.Builder |
preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
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 is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
dbClusterIdentifier - The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
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
Cannot 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
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
ModifyDbClusterRequest.Builder applyImmediately(Boolean applyImmediately)
A value that specifies whether the modifications in this request and any pending modifications are
asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting
for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied
during the next maintenance window.
The ApplyImmediately parameter only affects the NewDBClusterIdentifier and
MasterUserPassword values. If you set the ApplyImmediately parameter value to
false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are
applied during the next maintenance window. All other changes are applied immediately, regardless of the
value of the ApplyImmediately parameter.
Default: false
applyImmediately - A value that specifies whether the modifications in this request and any pending modifications are
asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to false, changes to the DB cluster
are applied during the next maintenance window.
The ApplyImmediately parameter only affects the NewDBClusterIdentifier and
MasterUserPassword values. If you set the ApplyImmediately parameter value
to false, then changes to the NewDBClusterIdentifier and MasterUserPassword
values are applied during the next maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately parameter.
Default: false
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)
(Not supported by Neptune)
optionGroupName - (Not supported by Neptune)ModifyDbClusterRequest.Builder preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
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 AWS Region.
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 AWS Region, occurring on a random day of the week.
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 AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
ModifyDbClusterRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
Default: false
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 the ApplyImmediately
parameter is set to true.
For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
engineVersion - The version number of the database engine to which you want to upgrade. Changing this parameter
results in an outage. The change is applied during the next maintenance window unless the
ApplyImmediately parameter is set to true.
For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
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 overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.ModifyDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.