ModifyDbClusterRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>, DocDbRequest.Builder, SdkBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyDbClusterRequest
```
public static interface ModifyDbClusterRequest.Builder
extends DocDbRequest.Builder, SdkPojo, CopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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 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.
`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 Amazon CloudWatch Logs for a specific instance or cluster.
`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.
`ModifyDbClusterRequest.Builder`	`dbClusterIdentifier(String dbClusterIdentifier)` The cluster identifier for the cluster that is being modified.
`ModifyDbClusterRequest.Builder`	`dbClusterParameterGroupName(String dbClusterParameterGroupName)` The name of the cluster parameter group to use for the cluster.
`ModifyDbClusterRequest.Builder`	`deletionProtection(Boolean deletionProtection)` Specifies whether this cluster can be deleted.
`ModifyDbClusterRequest.Builder`	`engineVersion(String engineVersion)` The version number of the database engine to which you want to upgrade.
`ModifyDbClusterRequest.Builder`	`masterUserPassword(String masterUserPassword)` The password for the master database user.
`ModifyDbClusterRequest.Builder`	`newDBClusterIdentifier(String newDBClusterIdentifier)` The new cluster identifier for the cluster when renaming a cluster.
`ModifyDbClusterRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`ModifyDbClusterRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`ModifyDbClusterRequest.Builder`	`port(Integer port)` The port number on which the 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 virtual private cloud (VPC) security groups that the cluster will belong to.
`ModifyDbClusterRequest.Builder`	`vpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of virtual private cloud (VPC) security groups that the cluster will belong to.

Methods inherited from interface software.amazon.awssdk.services.docdb.model.DocDbRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - dbClusterIdentifier
```
ModifyDbClusterRequest.Builder dbClusterIdentifier(String 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
```
ModifyDbClusterRequest.Builder newDBClusterIdentifier(String 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
```
ModifyDbClusterRequest.Builder 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 the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.
    
    The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the 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
    
    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 the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.
    
    The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the 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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - backupRetentionPeriod
```
ModifyDbClusterRequest.Builder backupRetentionPeriod(Integer backupRetentionPeriod)
```
    The number of days for which automated backups are retained. 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
```
ModifyDbClusterRequest.Builder dbClusterParameterGroupName(String 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
```
ModifyDbClusterRequest.Builder vpcSecurityGroupIds(Collection<String> 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
```
ModifyDbClusterRequest.Builder vpcSecurityGroupIds(String... 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
```
ModifyDbClusterRequest.Builder port(Integer port)
```
    The port number on which the cluster accepts connections.
    
    Constraints: Must be a value from 1150 to 65535.
    
    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 to 65535.
    
    Default: The same port as the original cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - masterUserPassword
```
ModifyDbClusterRequest.Builder masterUserPassword(String 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
```
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.
    
    Constraints:
    - Must be in the format hh24:mi-hh24:mi.
    - Must be in Universal Coordinated Time (UTC).
    - Must not conflict with the preferred maintenance window.
    - Must be at least 30 minutes.
    Parameters:
    preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
    
    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
    
    Constraints:
    
    Must be in the format hh24:mi-hh24:mi.
    
    Must be in Universal Coordinated Time (UTC).
    
    Must not conflict with the preferred maintenance window.
    
    Must be at least 30 minutes.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - preferredMaintenanceWindow
```
ModifyDbClusterRequest.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    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 and DisableLogTypes 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. The EnableLogTypes and DisableLogTypes 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 EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.
    This is a convenience method that creates an instance of the CloudwatchLogsExportConfiguration.Builder avoiding the need to create one manually via CloudwatchLogsExportConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration).
    
    Parameters:
    
    cloudwatchLogsExportConfiguration - a consumer that will call methods on CloudwatchLogsExportConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration)
  - engineVersion
```
ModifyDbClusterRequest.Builder engineVersion(String engineVersion)
```
    The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
    
    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 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"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allowMajorVersionUpgrade
```
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.
    
    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
```
ModifyDbClusterRequest.Builder deletionProtection(Boolean deletionProtection)
```
    Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
    
    Parameters:
    
    deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
ModifyDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
ModifyDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface ModifyDbClusterRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.docdb.model.DocDbRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

dbClusterIdentifier

newDBClusterIdentifier

applyImmediately

backupRetentionPeriod

dbClusterParameterGroupName

vpcSecurityGroupIds

vpcSecurityGroupIds

port

masterUserPassword

preferredBackupWindow

preferredMaintenanceWindow

cloudwatchLogsExportConfiguration

cloudwatchLogsExportConfiguration

engineVersion

allowMajorVersionUpgrade

deletionProtection

overrideConfiguration

overrideConfiguration