class Aws::DocDB::Types::ModifyDBClusterMessage

@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterMessage AWS API Documentation
@return [Boolean]
master user password.
Constraint: You must apply the change immediately when rotating the
cluster. The secret value contains the updated password.
Amazon DocumentDB in Amazon Web Services Secrets Manager for the
This setting is valid only if the master user password is managed by
Services Secrets Manager for the master user password.
Specifies whether to rotate the secret managed by Amazon Web
@!attribute [rw] rotate_master_user_password
@return [String]
each Amazon Web Services Region.
Your Amazon Web Services account has a different default KMS key for
There is a default KMS key for your Amazon Web Services account.
ARN.
different Amazon Web Services account, specify the key ARN or alias
alias ARN, or alias name for the KMS key. To use a KMS key in a
The Amazon Web Services KMS key identifier is the key ARN, key ID,
use a customer managed KMS key.
‘aws/secretsmanager` KMS key to encrypt the secret, and you must
Amazon Web Services account, then you can’t use the
is used to encrypt the secret. If the secret is in a different
`MasterUserSecretKmsKeyId`, then the ‘aws/secretsmanager` KMS key
turning on `ManageMasterUserPassword` and don’t specify
user password in Amazon Web Services Secrets Manager. If you are
* You are enabling ‘ManageMasterUserPassword` to manage the master
can’t change the KMS key that is used to encrypt the secret.
master user password in Amazon Web Services Secrets Manager, you
Services Secrets Manager. If the cluster already manages the
* The cluster doesn’t manage the master user password in Amazon Web
met:
This setting is valid only if both of the following conditions are
Secrets Manager.
is automatically generated and managed in Amazon Web Services
The Amazon Web Services KMS key identifier to encrypt a secret that
@!attribute [rw] master_user_secret_kms_key_id
@return [Boolean]
‘MasterUserPassword`.
secret and uses the new password for the master user specified by
`MasterUserPassword`. In this case, Amazon DocumentDB deletes the
Services Secrets Manager, then you must specify
that the master user password is not managed with Amazon Web
password with Amazon Web Services Secrets Manager, and you specify
`MasterUserPassword`. If the cluster already manages the master user
on this management. In this case, you can’t specify
user password with Amazon Web Services Secrets Manager, you can turn
Services Secrets Manager. If the cluster doesn’t manage the master
Specifies whether to manage the master user password with Amazon Web
@!attribute [rw] manage_master_user_password
@return [String]
Default value is ‘standard `
Valid values for storage type - `standard | iopt1`
Guide*.
Cluster storage configurations in the *Amazon DocumentDB Developer
For information on storage types for Amazon DocumentDB clusters, see
The storage type to associate with the DB cluster.
@!attribute [rw] storage_type
@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 [Boolean]
version than the DB cluster’s current version.
value for the ‘EngineVersion` parameter that is a different major
Constraints: You must allow major version upgrades when specifying a
A value that indicates whether major version upgrades are allowed.
@!attribute [rw] allow_major_version_upgrade
@return [String]
“DBEngineVersions[].EngineVersion”`
`aws docdb describe-db-engine-versions –engine docdb –query
use the following command:
To list all of the available engine versions for Amazon DocumentDB
is enabled.
applied during the next maintenance window unless `ApplyImmediately`
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
random day of the week.
block of time for each Amazon Web Services Region, occurring on a
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 Amazon Web Services 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
Represents the input to ModifyDBCluster.