class Aws::DocDB::Types::ModifyDBClusterMessage
@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterMessage AWS API Documentation
@return [Boolean]
deleted.
‘DeletionProtection` protects clusters from being accidentally
unless it is modified and `DeletionProtection` is disabled.
`DeletionProtection` is enabled, the cluster cannot be deleted
Specifies whether this cluster can be deleted. If
@!attribute [rw] deletion_protection
@return [String]
`ApplyImmediately` parameter is set to `true`.
applied during the next maintenance window unless the
upgrade. Changing this parameter results in an outage. The change is
The version number of the database engine to which you want to
@!attribute [rw] engine_version
@return [Types::CloudwatchLogsExportConfiguration]
are exported (or not exported) to CloudWatch Logs.
`EnableLogTypes` and `DisableLogTypes` arrays determine which logs
to Amazon CloudWatch Logs for a specific instance or cluster. The
The configuration setting for the log types to be enabled for export
@!attribute [rw] cloudwatch_logs_export_configuration
@return [String]
Constraints: Minimum 30-minute window.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
week.
block of time for each AWS Region, occurring on a random day of the
The default is a 30-minute window selected at random from an 8-hour
Format: `ddd:hh24:mi-ddd:hh24:mi`
Universal Coordinated Time (UTC).
The weekly time range during which system maintenance can occur, in
@!attribute [rw] preferred_maintenance_window
@return [String]
* Must be at least 30 minutes.
* Must not conflict with the preferred maintenance window.
* Must be in Universal Coordinated Time (UTC).
* Must be in the format `hh24:mi-hh24:mi`.
Constraints:
block of time for each AWS Region.
The default is a 30-minute window selected at random from an 8-hour
parameter.
automated backups are enabled, using the `BackupRetentionPeriod`
The daily time range during which automated backups are created if
@!attribute [rw] preferred_backup_window
@return [String]
Constraints: Must contain from 8 to 100 characters.
(“), or the ”at“ symbol (@).
any printable ASCII character except forward slash (/), double quote
The password for the master database user. This password can contain
@!attribute [rw] master_user_password
@return [Integer]
Default: The same port as the original cluster.
Constraints: Must be a value from `1150` to `65535`.
The port number on which the cluster accepts connections.
@!attribute [rw] port
@return [Array<String>]
cluster will belong to.
A list of virtual private cloud (VPC) security groups that the
@!attribute [rw] vpc_security_group_ids
@return [String]
The name of the cluster parameter group to use for the cluster.
@!attribute [rw] db_cluster_parameter_group_name
@return [Integer]
^
* Must be a value from 1 to 35.
Constraints:
Default: 1
must specify a minimum value of 1.
The number of days for which automated backups are retained. You
@!attribute [rw] backup_retention_period
@return [Boolean]
Default: `false`
parameter.
immediately, regardless of the value of the `ApplyImmediately`
during the next maintenance window. All other changes are applied
`NewDBClusterIdentifier` and `MasterUserPassword` values are applied
this parameter value to `false`, the changes to the
`NewDBClusterIdentifier` and `MasterUserPassword` values. If you set
The `ApplyImmediately` parameter affects only the
are applied during the next maintenance window.
cluster. If this parameter is set to `false`, changes to the cluster
regardless of the `PreferredMaintenanceWindow` setting for the
pending changes are asynchronously applied as soon as possible,
A value that specifies whether the changes in this request and any
@!attribute [rw] apply_immediately
@return [String]
Example: `my-cluster2`
* Cannot end with a hyphen or contain two consecutive hyphens.
* The first character must be a letter.
* Must contain from 1 to 63 letters, numbers, or hyphens.
Constraints:
This value is stored as a lowercase string.
The new cluster identifier for the cluster when renaming a cluster.
@!attribute [rw] new_db_cluster_identifier
@return [String]
^
* Must match the identifier of an existing `DBCluster`.
Constraints:
parameter is not case sensitive.
The cluster identifier for the cluster that is being modified. This
@!attribute [rw] db_cluster_identifier
}
deletion_protection: false,
engine_version: ”String“,
},
disable_log_types: [”String“],
enable_log_types: [”String“],
cloudwatch_logs_export_configuration: {
preferred_maintenance_window: ”String“,
preferred_backup_window: ”String“,
master_user_password: ”String“,
port: 1,
vpc_security_group_ids: [”String“],
db_cluster_parameter_group_name: ”String“,
backup_retention_period: 1,
apply_immediately: false,
new_db_cluster_identifier: ”String“,
db_cluster_identifier: ”String“, # required
{
data as a hash:
@note When making an API call, you may pass ModifyDBClusterMessage
Represents the input to ModifyDBCluster.