ModifyDBCluster

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

请求参数

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

DBClusterIdentifier

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

约束：

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

类型：字符串

必需：是

AllowMajorVersionUpgrade

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

约束：

• 将 EngineVersion 参数的值指定为不同于集群当前版本的主要版本时，必须允许主要版本升级。

• 由于某些参数是特定于版本的，因此对其进行更改需要在就地 MVU 完成后执行新的 ModifyDBCluster API 调用。

注意

执行 MVU 会直接影响以下参数：

• MasterUserPassword

• NewDBClusterIdentifier

• VpcSecurityGroupIds

• Port

类型：布尔值

必需：否

ApplyImmediately

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

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

默认值：false

类型：布尔值

必需：否

BackupRetentionPeriod

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

默认值：1

约束：

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

类型：整数

必需：否

CloudwatchLogsExportConfiguration

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

类型：CloudwatchLogsExportConfiguration 对象

必需：否

DBClusterParameterGroupName

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

类型：字符串

必需：否

DeletionProtection

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

类型：布尔值

必需：否

EngineVersion

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

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

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

类型：字符串

必需：否

ManageMasterUserPassword

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

类型：布尔值

必需：否

MasterUserPassword

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

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

类型：字符串

必需：否

MasterUserSecretKmsKeyId

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

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

• 集群未在 Amazon Web Services Secrets Manager 中管理主用户密码。如果集群已在 Amazon Web Services Secrets Manager 中管理主用户密码，则您无法更改用于对密钥进行加密的 KMS 密钥。

• 您将启用 ManageMasterUserPassword 以在 Amazon Web Services Secrets Manager 中管理主用户密码。如果您正在开启 ManageMasterUserPassword 但未指定 MasterUserSecretKmsKeyId，则使用 aws/secretsmanager KMS 密钥来对密钥进行加密。如果密钥位于不同的 Amazon Web Services 账户中，则无法使用 aws/secretsmanager KMS 密钥来对其进行加密，必须使用客户管理的 KMS 密钥。

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

您的 Amazon Web Services 账户有默认 KMS 密钥。您的 Amazon Web Services 账户对每个 Amazon Web Services 区域具有不同的默认 KMS 密钥。

类型：字符串

必需：否

NetworkType

集群的网络类型。

网络类型由为集群指定的 DBSubnetGroup 确定。DBSubnetGroup 只可以支持 IPv4 协议或 IPv4 和 IPv6 协议（DUAL）。

有关更多信息，请参阅《Amazon DocumentDB 开发人员指南》中 VPC 中的 DocumentDB 集群。

有效值：IPV4 | DUAL

类型：字符串

必需：否

NewDBClusterIdentifier

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

约束：

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

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

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

示例：my-cluster2

类型：字符串

必需：否

Port

集群接受连接的端口号。

约束：必须是介于 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、Wed、Thu、Fri、Sat、Sun

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

类型：字符串

必需：否

RotateMasterUserPassword

指示是否轮换 Amazon Web Services Secrets Manager 管理的用于主用户密码的密钥。

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

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

类型：布尔值

必需：否

ServerlessV2ScalingConfiguration

包含 Amazon DocumentDB 无服务器集群的扩缩配置。

类型：ServerlessV2ScalingConfiguration 对象

必需：否

StorageType

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

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

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

默认值为 standard

类型：字符串

必需：否

VpcSecurityGroupIds.VpcSecurityGroupId.N

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

类型：字符串数组

必需：否

响应元素

服务返回以下元素。

DBCluster

有关集群的详细信息。

类型：DBCluster 对象

错误

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

DBClusterAlreadyExistsFault

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

HTTP 状态代码：400

DBClusterNotFoundFault

DBClusterIdentifier 并不引用现有集群。

HTTP 状态代码：404

DBClusterParameterGroupNotFound

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

HTTP 状态代码：404

DBSubnetGroupNotFoundFault

DBSubnetGroupName 并不引用现有子网组。

HTTP 状态代码：404

InvalidDBClusterStateFault

集群未处于有效状态。

HTTP 状态代码：400

InvalidDBInstanceState

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

HTTP 状态代码：400

InvalidDBSecurityGroupState

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

HTTP 状态代码：400

InvalidDBSubnetGroupStateFault

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

HTTP 状态代码：400

InvalidSubnet

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

HTTP 状态代码：400

InvalidVPCNetworkStateFault

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

HTTP 状态代码：400

NetworkTypeNotSupported

DBSubnetGroup 或数据库引擎版本不支持该网络类型。

HTTP 状态代码：400

StorageQuotaExceeded

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

HTTP 状态代码：400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：

• AWS 命令行界面 V2

• AWS SDK for .NET

• 适用于 C++ 的 AWS SDK

• 适用于 Go v2 的 AWS SDK

• 适用于 Java V2 的 AWS SDK

• AWS 适用于 JavaScript 的开发工具包 V3

• 适用于 Kotlin 的 AWS SDK

• 适用于 PHP V3 的 AWS SDK

• 适用于 Python 的 AWS SDK

• 适用于 Ruby V3 的 AWS SDK