docdb/aws.sdk.kotlin.services.docdb.model/ModifyDbClusterRequest

ModifyDbClusterRequest

class ModifyDbClusterRequest

Represents the input to ModifyDBCluster.

Types

Builder

class Builder

Companion

object Companion

Properties

allowMajorVersionUpgrade

val allowMajorVersionUpgrade: Boolean?

A value that indicates whether major version upgrades are allowed.

applyImmediately

val applyImmediately: Boolean?

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.

backupRetentionPeriod

val backupRetentionPeriod: Int?

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

cloudwatchLogsExportConfiguration

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

dbClusterIdentifier

val dbClusterIdentifier: String?

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

dbClusterParameterGroupName

val dbClusterParameterGroupName: String?

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

deletionProtection

val deletionProtection: Boolean?

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.

engineVersion

val engineVersion: String?

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.

masterUserPassword

val masterUserPassword: String?

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

newDbClusterIdentifier

val newDbClusterIdentifier: String?

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

port

val port: Int?

The port number on which the cluster accepts connections.

preferredBackupWindow

val preferredBackupWindow: String?

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

preferredMaintenanceWindow

val preferredMaintenanceWindow: String?

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).