Interface ModifyDbClusterRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ModifyDbClusterRequest.Builder,
,ModifyDbClusterRequest> DocDbRequest.Builder
,SdkBuilder<ModifyDbClusterRequest.Builder,
,ModifyDbClusterRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ModifyDbClusterRequest
-
Method Summary
Modifier and TypeMethodDescriptionallowMajorVersionUpgrade
(Boolean allowMajorVersionUpgrade) A value that indicates whether major version upgrades are allowed.applyImmediately
(Boolean applyImmediately) A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of thePreferredMaintenanceWindow
setting for the cluster.backupRetentionPeriod
(Integer backupRetentionPeriod) The number of days for which automated backups are retained.default ModifyDbClusterRequest.Builder
cloudwatchLogsExportConfiguration
(Consumer<CloudwatchLogsExportConfiguration.Builder> cloudwatchLogsExportConfiguration) The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.cloudwatchLogsExportConfiguration
(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration) The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.dbClusterIdentifier
(String dbClusterIdentifier) The cluster identifier for the cluster that is being modified.dbClusterParameterGroupName
(String dbClusterParameterGroupName) The name of the cluster parameter group to use for the cluster.deletionProtection
(Boolean deletionProtection) Specifies whether this cluster can be deleted.engineVersion
(String engineVersion) The version number of the database engine to which you want to upgrade.manageMasterUserPassword
(Boolean manageMasterUserPassword) Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.masterUserPassword
(String masterUserPassword) The password for the master database user.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.newDBClusterIdentifier
(String newDBClusterIdentifier) The new cluster identifier for the cluster when renaming a cluster.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The port number on which the cluster accepts connections.preferredBackupWindow
(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, using theBackupRetentionPeriod
parameter.preferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).rotateMasterUserPassword
(Boolean rotateMasterUserPassword) Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.storageType
(String storageType) The storage type to associate with the DB cluster.vpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups that the cluster will belong to.vpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups that the cluster will belong to.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.docdb.model.DocDbRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
dbClusterIdentifier
The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.
Constraints:
-
Must match the identifier of an existing
DBCluster
.
- Parameters:
dbClusterIdentifier
- The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.Constraints:
-
Must match the identifier of an existing
DBCluster
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
newDBClusterIdentifier
The new cluster identifier for the cluster when renaming a 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
- Parameters:
newDBClusterIdentifier
- The new cluster identifier for the cluster when renaming a 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
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
applyImmediately
A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow
setting for the cluster. If this parameter is set tofalse
, changes to the cluster are applied during the next maintenance window.The
ApplyImmediately
parameter affects only theNewDBClusterIdentifier
andMasterUserPassword
values. If you set this parameter value tofalse
, the changes to theNewDBClusterIdentifier
andMasterUserPassword
values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediately
parameter.Default:
false
- Parameters:
applyImmediately
- A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of thePreferredMaintenanceWindow
setting for the cluster. If this parameter is set tofalse
, changes to the cluster are applied during the next maintenance window.The
ApplyImmediately
parameter affects only theNewDBClusterIdentifier
andMasterUserPassword
values. If you set this parameter value tofalse
, the changes to theNewDBClusterIdentifier
andMasterUserPassword
values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediately
parameter.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backupRetentionPeriod
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
-
Must be a value from 1 to 35.
- Parameters:
backupRetentionPeriod
- The number of days for which automated backups are retained. You must specify a minimum value of 1.Default: 1
Constraints:
-
Must be a value from 1 to 35.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dbClusterParameterGroupName
The name of the cluster parameter group to use for the cluster.
- Parameters:
dbClusterParameterGroupName
- The name of the cluster parameter group to use for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
A list of virtual private cloud (VPC) security groups that the cluster will belong to.
- Parameters:
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups that the cluster will belong to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
A list of virtual private cloud (VPC) security groups that the cluster will belong to.
- Parameters:
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups that the cluster will belong to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
port
The port number on which the cluster accepts connections.
Constraints: Must be a value from
1150
to65535
.Default: The same port as the original cluster.
- Parameters:
port
- The port number on which the cluster accepts connections.Constraints: Must be a value from
1150
to65535
.Default: The same port as the original cluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
masterUserPassword
The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
- Parameters:
masterUserPassword
- The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).Constraints: Must contain from 8 to 100 characters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
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 theBackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
- Parameters:
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudwatchLogsExportConfiguration
ModifyDbClusterRequest.Builder cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration) The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The
EnableLogTypes
andDisableLogTypes
arrays determine which logs are exported (or not exported) to CloudWatch Logs.- Parameters:
cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. TheEnableLogTypes
andDisableLogTypes
arrays determine which logs are exported (or not exported) to CloudWatch Logs.- 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 Amazon CloudWatch Logs for a specific instance or cluster. The
This is a convenience method that creates an instance of theEnableLogTypes
andDisableLogTypes
arrays determine which logs are exported (or not exported) to CloudWatch Logs.CloudwatchLogsExportConfiguration.Builder
avoiding the need to create one manually viaCloudwatchLogsExportConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration)
.- Parameters:
cloudwatchLogsExportConfiguration
- a consumer that will call methods onCloudwatchLogsExportConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 Amazon DocumentDB use the following command:
aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"
- 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 unlessApplyImmediately
is enabled.To list all of the available engine versions for Amazon DocumentDB use the following command:
aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deletionProtection
Specifies whether this cluster can be deleted. If
DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.- Parameters:
deletionProtection
- Specifies whether this cluster can be deleted. IfDeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageType
The storage type to associate with the DB cluster.
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type -
standard | iopt1
Default value is
standard
- Parameters:
storageType
- The storage type to associate with the DB cluster.For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type -
standard | iopt1
Default value is
standard
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
manageMasterUserPassword
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the 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 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 specifyMasterUserPassword
. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified byMasterUserPassword
.- Parameters:
manageMasterUserPassword
- Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the 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 specifyMasterUserPassword
. If the 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 specifyMasterUserPassword
. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified byMasterUserPassword
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the 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 enabling
ManageMasterUserPassword
to manage the master user password in Amazon Web Services Secrets Manager. If you are turning onManageMasterUserPassword
and don't specifyMasterUserSecretKmsKeyId
, then theaws/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 theaws/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.
- 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 cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the 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 enabling
ManageMasterUserPassword
to manage the master user password in Amazon Web Services Secrets Manager. If you are turning onManageMasterUserPassword
and don't specifyMasterUserSecretKmsKeyId
, then theaws/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 theaws/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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.
Constraint: 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 Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.
Constraint: 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.
-
overrideConfiguration
ModifyDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-