/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.docdb.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Represents the input to ModifyDBCluster. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ModifyDBClusterRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The cluster identifier for the cluster that is being modified. This parameter is not case sensitive. *

*

* Constraints: *

* */ private String dBClusterIdentifier; /** *

* The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string. *

*

* Constraints: *

* *

* Example: my-cluster2 *

*/ private String newDBClusterIdentifier; /** *

* 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 *

*/ private Boolean applyImmediately; /** *

* The number of days for which automated backups are retained. You must specify a minimum value of 1. *

*

* Default: 1 *

*

* Constraints: *

* */ private Integer backupRetentionPeriod; /** *

* The name of the cluster parameter group to use for the cluster. *

*/ private String dBClusterParameterGroupName; /** *

* A list of virtual private cloud (VPC) security groups that the cluster will belong to. *

*/ private java.util.List vpcSecurityGroupIds; /** *

* 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. *

*/ private Integer port; /** *

* 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. *

*/ private String masterUserPassword; /** *

* 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: *

* */ private String preferredBackupWindow; /** *

* 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. *

*/ private String preferredMaintenanceWindow; /** *

* 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. *

*/ private CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration; /** *

* 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" *

*/ private String engineVersion; /** *

* 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. *

*/ private Boolean allowMajorVersionUpgrade; /** *

* 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. *

*/ private Boolean deletionProtection; /** *

* The cluster identifier for the cluster that is being modified. This parameter is not case sensitive. *

*

* Constraints: *

* * * @param dBClusterIdentifier * The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

*

* Constraints: *

*