ModifyDbClusterRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.ModifyDbClusterRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyDbClusterRequest
extends RdsRequest
implements ToCopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModifyDbClusterRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ModifyDbClusterRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allowMajorVersionUpgrade()` A value that indicates whether major version upgrades are allowed.
`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.
`Long`	`backtrackWindow()` The target backtrack window, in seconds.
`Integer`	`backupRetentionPeriod()` The number of days for which automated backups are retained.
`static ModifyDbClusterRequest.Builder`	`builder()`
`CloudwatchLogsExportConfiguration`	`cloudwatchLogsExportConfiguration()` The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
`Boolean`	`copyTagsToSnapshot()` A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
`String`	`dbClusterIdentifier()` The DB cluster identifier for the cluster being modified.
`String`	`dbClusterParameterGroupName()` The name of the DB cluster parameter group to use for the DB cluster.
`String`	`dbInstanceParameterGroupName()` The name of the DB parameter group to apply to all instances of the DB cluster.
`Boolean`	`deletionProtection()` A value that indicates whether the DB cluster has deletion protection enabled.
`String`	`domain()` The Active Directory directory ID to move the DB cluster to.
`String`	`domainIAMRoleName()` Specify the name of the IAM role to be used when making API calls to the Directory Service.
`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).
`Boolean`	`enableHttpEndpoint()` A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
`Boolean`	`enableIAMDatabaseAuthentication()` A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts.
`String`	`engineVersion()` The version number of the database engine to which you want to upgrade.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasVpcSecurityGroupIds()` Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`masterUserPassword()` The new password for the master database user.
`String`	`newDBClusterIdentifier()` The new DB cluster identifier for the DB cluster when renaming a DB cluster.
`String`	`optionGroupName()` A value that indicates that the DB cluster should be associated with the specified option group.
`Integer`	`port()` The port number on which the DB cluster accepts connections.
`String`	`preferredBackupWindow()` The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.
`String`	`preferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`ScalingConfiguration`	`scalingConfiguration()` The scaling properties of the DB cluster.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyDbClusterRequest.Builder>`	`serializableBuilderClass()`
`ModifyDbClusterRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`vpcSecurityGroupIds()` A list of VPC security groups that the DB cluster will belong to.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - dbClusterIdentifier
```
public final 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.
    
    Returns:
    
    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.
  - newDBClusterIdentifier
```
public final 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
    Returns:
    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
  - applyImmediately
```
public final 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.
    
    Returns:
    
    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.
  - backupRetentionPeriod
```
public final 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
    Returns:
    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
  - dbClusterParameterGroupName
```
public final String dbClusterParameterGroupName()
```
    The name of the DB cluster parameter group to use for the DB cluster.
    
    Returns:
    
    The name of the DB cluster parameter group to use for the DB cluster.
  - hasVpcSecurityGroupIds
```
public final boolean hasVpcSecurityGroupIds()
```
    Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - vpcSecurityGroupIds
```
public final List<String> vpcSecurityGroupIds()
```
    A list of VPC security groups that the DB cluster will belong to.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasVpcSecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    A list of VPC security groups that the DB cluster will belong to.
  - port
```
public final 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.
    
    Returns:
    
    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.
  - masterUserPassword
```
public final 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.
    
    Returns:
    
    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.
  - optionGroupName
```
public final String optionGroupName()
```
    A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
    
    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
    
    Returns:
    
    A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
    
    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
  - preferredBackupWindow
```
public final 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.
    Returns:
    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.
  - preferredMaintenanceWindow
```
public final 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.
    
    Returns:
    
    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.
  - enableIAMDatabaseAuthentication
```
public final Boolean enableIAMDatabaseAuthentication()
```
    A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Returns:
    
    A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
  - backtrackWindow
```
public final Long backtrackWindow()
```
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Currently, Backtrack is only supported for Aurora MySQL DB clusters.
    
    Default: 0
    
    Constraints:
    - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Returns:
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Currently, Backtrack is only supported for Aurora MySQL DB clusters.
    
    Default: 0
    
    Constraints:
    
    If specified, this value must be set to a number from 0 to 259,200 (72 hours).
  - cloudwatchLogsExportConfiguration
```
public final CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration()
```
    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
    
    Returns:
    
    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
  - engineVersion
```
public final String engineVersion()
```
    The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
    
    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-postgresql, use the following command:
    
    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
    
    Returns:
    
    The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
    
    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-postgresql, use the following command:
    
    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
  - allowMajorVersionUpgrade
```
public final 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.
    
    Returns:
    
    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.
  - dbInstanceParameterGroupName
```
public final String dbInstanceParameterGroupName()
```
    The name of the DB parameter group to apply to all instances of the DB cluster.
    
    When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.
    
    Default: The existing name setting
    
    Constraints:
    - The DB parameter group must be in the same DB parameter group family as this DB cluster.
    - The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.
    Returns:
    The name of the DB parameter group to apply to all instances of the DB cluster.
    
    When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.
    
    Default: The existing name setting
    
    Constraints:
    
    The DB parameter group must be in the same DB parameter group family as this DB cluster.
    
    The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.
  - domain
```
public final 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.
    
    Returns:
    
    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.
  - domainIAMRoleName
```
public final String domainIAMRoleName()
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    Returns:
    
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
  - scalingConfiguration
```
public final ScalingConfiguration scalingConfiguration()
```
    The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
    
    Returns:
    
    The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
  - deletionProtection
```
public final 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.
    
    Returns:
    
    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.
  - enableHttpEndpoint
```
public final Boolean enableHttpEndpoint()
```
    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
    
    Returns:
    
    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
  - copyTagsToSnapshot
```
public final 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.
    
    Returns:
    
    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.
  - enableGlobalWriteForwarding
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public ModifyDbClusterRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyDbClusterRequest.Builder,ModifyDbClusterRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static ModifyDbClusterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModifyDbClusterRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ModifyDbClusterRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

dbClusterIdentifier

newDBClusterIdentifier

applyImmediately

backupRetentionPeriod

dbClusterParameterGroupName

hasVpcSecurityGroupIds

vpcSecurityGroupIds

port

masterUserPassword

optionGroupName

preferredBackupWindow

preferredMaintenanceWindow

enableIAMDatabaseAuthentication

backtrackWindow

cloudwatchLogsExportConfiguration

engineVersion

allowMajorVersionUpgrade

dbInstanceParameterGroupName

domain

domainIAMRoleName

scalingConfiguration

deletionProtection

enableHttpEndpoint

copyTagsToSnapshot

enableGlobalWriteForwarding

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields