ModifyDBCluster

要修改的集群的集群标识符。此参数不区分大小写。

约束：

类型：字符串

必需：是

指示是否允许主要版本升级的值。

约束：将 EngineVersion 参数的值指定为不同于数据库实例当前版本的主要版本时，必须允许主要版本升级。

类型：布尔值

必需：否

指定应尽快异步应用此请求中修改及任何待处理修改的值，无论集群的 PreferredMaintenanceWindow 设置如何。如果此参数设置为 false，则在下一个维护时段中应用对集群的更改。

ApplyImmediately 参数仅影响 NewDBClusterIdentifier 和 MasterUserPassword 值。如果将此参数值设置为 false，则对 NewDBClusterIdentifier 和 MasterUserPassword 值的更改在下一维护时段中应用。所有其他更改会立即应用，而不管 ApplyImmediately 参数的值如何。

默认值：false

类型：布尔值

必需：否

自动备份的保留天数。您必须指定最小值 1。

默认值：1

约束：

类型：整数

必需：否

允许将日志类型导出到特定实例或集群的 Amazon CloudWatch Logs 的配置设置。EnableLogTypes和DisableLogTypes数组决定将哪些日志导出（或不导出）到 CloudWatch 日志。

类型：CloudwatchLogsExportConfiguration 对象

必需：否

用于集群的集群参数组的名称。

类型：字符串

必需：否

指定是否可以删除此集群。如果 DeletionProtection 启用，则无法删除集群，除非集群经修改并 DeletionProtection 禁用。DeletionProtection 防止意外删除集群。

类型：布尔值

必需：否

要升级到的数据库引擎的版本号。更改此参数会导致中断。除非 ApplyImmediately 启用，否则会在下个维护时段内应用更改。

要列出 Amazon DocumentDB 的所有可用引擎版本，请使用以下命令：

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

类型：字符串

必需：否

指定是否使用亚马逊 Web Services Secrets Manager 管理主用户密码。如果集群无法使用 Amazon Web Services Secrets Manager 管理主用户密码，则可以启用此管理。在这种情况下，您无法指定MasterUserPassword。如果集群已经使用 Amazon Web Services Secrets Manager 管理主用户密码，并且您指定主用户密码不是由 Amazon Web Services Secrets Manager 管理的，则必须指定MasterUserPassword。在这种情况下，Amazon DocumentDB 会删除密码并使用由指定的主用户的新密码。MasterUserPassword

类型：布尔值

必需：否

主数据库用户的密码。此密码可以包含除正斜杠 (/)、双引号 (") 或 @ 符号之外的任何可打印的 ASCII 字符。

约束：必须包含 8 到 100 个字符。

类型：字符串

必需：否

Amazon Web Services KMS 密钥标识符，用于加密在亚马逊 Web Services Secrets Manager 中自动生成和管理的密钥。

仅当满足以下两个条件时，此设置才有效：

Amazon Web Services KMS 密钥标识符是 KMS 密钥的密钥 ARN、密钥 ID、别名 ARN 或 KMS 密钥的别名。要在不同的亚马逊 Web Services 账户中使用 KMS 密钥，请指定密钥 ARN 或别名 ARN。

您的 Amazon Web Services 账户有默认 KMS 密钥。您的亚马逊云科技账户在每个亚马逊云科技区域都有不同的默认 KMS 密钥。

类型：字符串

必需：否

重命名集群时集群的新集群标识符。此值以一个小写字符串存储。

约束：

示例：my-cluster2

类型：字符串

必需：否

集群接受连接的端口号。

约束：必须是介于 1150 到 65535的值。

默认值：与原始数据库集群相同的端口。

类型：整数

必需：否

使用 BackupRetentionPeriod 参数启用了自动备份时，自动执行备份的日常时间范围。

默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口。 Amazon Web Services 区域

约束：

类型：字符串

必需：否

可进行系统维护的每周时间范围（采用通用协调时间（UTC））。

格式：ddd:hh24:mi-ddd:hh24:mi

默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口 Amazon Web Services 区域，出现在一周中的随机某一天。

有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun

约束：至少为 30 分钟的时段。

类型：字符串

必需：否

指定是否轮换由 Amazon Web Services Secrets Manager 管理的密钥作为主用户密码。

只有当主用户密码由 Amazon DocumentDB 在集群的 Amazon Web Services Secrets Manager 中管理时，此设置才有效。密钥值包含更新的密码。

约束：轮换主用户密码时必须立即应用更改。

类型：布尔值

必需：否

与数据库集群关联的存储类型。

有关 Amazon DocumentDB 集群存储类型的信息，请参阅《Amazon DocumentDB 开发人员指南》中的集群存储配置。

存储类型的有效值 - standard | iopt1

默认值为 standard

类型：字符串

必需：否

集群将隶属于的 Virtual Private Cloud (VPC) 安全组的列表。

类型：字符串数组

必需：否

有关集群的详细信息。

类型：DBCluster 对象

用户已拥有具有给定标识符的集群。

HTTP 状态代码：400

DBClusterIdentifier 并不引用现有集群。

HTTP 状态代码：404

DBClusterParameterGroupName 并不引用现有集群参数组。

HTTP 状态代码：404

DBSubnetGroupName 并不引用现有子网组。

HTTP 状态代码：404

集群未处于有效状态。

HTTP 状态代码：400

指定的实例未处于可用 状态。

HTTP 状态代码：400

安全组的状态不允许执行删除。

HTTP 状态代码：400

无法删除子网组，因为它正在使用中。

HTTP 状态代码：400

请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。

HTTP 状态代码：400

由于所做的更改，子网组在创建后并不会覆盖所有可用区。

HTTP 状态代码：400

该请求会导致您超出跨所有实例可提供的已允许存储量。

HTTP 状态代码：400