ModifyDBCluster - Amazon DocumentDB
请求参数响应元素Errors另请参阅
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

ModifyDBCluster

修改 Amazon DocumentDB 集群的设置。您可通过在请求中指定这些参数以及新值，更改一个或多个数据库配置参数。

请求参数

有关所有操作通用的参数的信息，请参阅常见参数。

DBClusterIdentifier

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

约束：

  • 必须匹配现有的标识符DBCluster。

类型: 字符串

：必需 是

立即应用

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

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

默认值：false

类型: Boolean

：必需 否

BackupRetentionPeriod

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

默认值：1

约束：

  • 必须为介于 1 和 35 之间的值。

类型: 整数

：必需 否

CloudwatchLogsExportConfiguration

要启用日志类型的配置设置，以便针对特定实例或集群导出到 Amazon CloudWatch Logs。这些区域有：EnableLogTypes和DisableLogTypes数组确定要将哪些日志导出（或未导出）到 CloudWatch Logs。

类型：CloudwatchLogsExportConfiguration 对象

：必需 否

DBClusterParameterGroupName

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

类型: 字符串

：必需 否

DeletionProtection

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

类型: Boolean

：必需 否

EngineVersion

要升级到的数据库引擎的版本号。Amazon DocumentDB 不支持修改引擎版本。

类型: 字符串

：必需 否

MasterUserPassword

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

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

类型: 字符串

：必需 否

NewDBClusterIdentifier

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

约束：

  • 必须包含 1 到 63 个字母、数字或连字符。

  • 第一个字符必须是字母。

  • 不能以连字符结束或包含两个连续连字符。

例如：my-cluster2

类型: 字符串

：必需 否

端口

集群接受连接的端口号。

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

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

类型: 整数

：必需 否

PreferredBackupWindow

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

默认值是从每个 AWS 区域的 8 小时时间段中随机选择的 30 分钟时间。

约束：

  • 必须采用 hh24:mi-hh24:mi 格式。

  • 必须采用通用协调时间 (UTC)。

  • 不得与首选维护时段冲突。

  • 必须至少为 30 分钟。

类型: 字符串

：必需 否

PreferredMaintenanceWindow

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

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

默认值是每个 AWS 区域 8 小时的时间段中随机选择的 30 分钟时段（随机选取周中的某天进行）。

有效天：Mon、Tue、Wue、Tue、Tue、Tue、Fat、Sun

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

类型: 字符串

：必需 否

VPC 安全组。VPC 安全组。n

集群所属的虚拟私有云 (VPC) 安全组的列表。

类型: 字符串数组

：必需 否

响应元素

服务返回以下元素。

DBCluster

有关集群的详细信息。

类型：DBCluster 对象

Errors

有关所有操作常见错误的信息，请参阅常见错误。

DBClusterAlreadyExistsFault

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

HTTP 状态代码：400

DBClusterNotFoundFault

DBClusterIdentifier不引用现有集群。

HTTP 状态代码：404

未找到数据库集群参数组

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

HTTP 状态代码：404

DBSubnetGroupNotFoundFault

DBSubnetGroupName不引用现有子网组。

HTTP 状态代码：404

InvalidDBClusterStateFault

集群未处于有效状态。

HTTP 状态代码：400

无法生效的国家

指定的实例不在available状态。

HTTP 状态代码：400

无效安全组状态

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

HTTP 状态代码：400

InvalidDBSubnetGroupStateFault

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

HTTP 状态代码：400

InvalidSubnet

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

HTTP 状态代码：400

InvalidVPCNetworkStateFault

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

HTTP 状态代码：400

已超出存储时间

请求将导致您超过所有实例中可用的允许存储量。

HTTP 状态代码：400

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：