本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
ModifyDBCluster
修改 Amazon DocumentDB 集群的设置。您可通过在请求中指定这些参数以及新值，更改一个或多个数据库配置参数。
请求参数
有关所有操作的通用参数的信息，请参阅通用参数。
- DBClusterIdentifier
-
要修改的集群的集群标识符。此参数不区分大小写。
约束：
-
必须与现有
DBCluster的标识符匹配。
类型：字符串
必需：是
-
- AllowMajorVersionUpgrade
-
指示是否允许主要版本升级的值。
约束：将
EngineVersion参数的值指定为不同于数据库实例当前版本的主要版本时，必须允许主要版本升级。类型：布尔值
必需：否
- ApplyImmediately
-
指定应尽快异步应用此请求中修改及任何待处理修改的值，无论集群的
PreferredMaintenanceWindow设置如何。如果此参数设置为false，则在下一个维护时段中应用对集群的更改。ApplyImmediately参数仅影响NewDBClusterIdentifier和MasterUserPassword值。如果将此参数值设置为false，则对NewDBClusterIdentifier和MasterUserPassword值的更改在下一维护时段中应用。所有其他更改会立即应用，而不管ApplyImmediately参数的值如何。默认值：
false类型：布尔值
必需：否
- BackupRetentionPeriod
-
自动备份的保留天数。您必须指定最小值 1。
默认值：1
约束：
-
必须为介于 1 和 35 之间的值。
类型：整数
必需：否
-
- CloudwatchLogsExportConfiguration
-
允许将日志类型导出到特定实例或集群的 Amazon CloudWatch Logs 的配置设置。
EnableLogTypes和DisableLogTypes数组决定将哪些日志导出（或不导出）到 CloudWatch 日志。类型：CloudwatchLogsExportConfiguration 对象
必需：否
- DBClusterParameterGroupName
-
用于集群的集群参数组的名称。
类型：字符串
必需：否
- DeletionProtection
-
指定是否可以删除此集群。如果
DeletionProtection启用，则无法删除集群，除非集群经修改并DeletionProtection禁用。DeletionProtection防止意外删除集群。类型：布尔值
必需：否
- EngineVersion
-
要升级到的数据库引擎的版本号。更改此参数会导致中断。除非
ApplyImmediately启用，否则会在下个维护时段内应用更改。要列出 Amazon DocumentDB 的所有可用引擎版本，请使用以下命令：
aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"类型：字符串
必需：否
- ManageMasterUserPassword
-
指定是否使用亚马逊 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
-
主数据库用户的密码。此密码可以包含除正斜杠 (/)、双引号 (“) 或 “at” 符号 (@) 之外的任何可打印ASCII字符。
约束：必须包含 8 到 100 个字符。
类型：字符串
必需：否
- MasterUserSecretKmsKeyId
-
Amazon Web Ser KMS vices 密钥标识符，用于加密在亚马逊 Web Services Secrets Manager 中自动生成和管理的密钥。
仅当满足以下两个条件时，此设置才有效：
-
集群不管理 Amazon Web Services Secrets Manager 中的主用户密码。如果集群已经在 Amazon Web Services Secrets Manager 中管理了主用户密码，则您无法更改用于加密密KMS钥的密钥。
-
您可以在 Amazon Web Services Secrets Manager 中管理主用户密码。
ManageMasterUserPassword如果您正在开启ManageMasterUserPassword但未指定MasterUserSecretKmsKeyId，则密aws/secretsmanagerKMS钥将用于加密密钥。如果密钥位于其他 Amazon Web Services 账户中，则您无法使用该密aws/secretsmanagerKMS钥加密该密钥，并且必须使用客户托管密KMS钥。
Amazon Web Services 密KMS钥ARN标识符是密钥的密钥ARN、密KMS钥 ID、别名或别名。要在另一个 Amazon Web Services 账户中使用密KMS钥，请指定密钥ARN或别名ARN。
您的亚马逊 Web Services 账户有一个默认KMS密钥。您的亚马逊 Web Services 账户在每个亚马逊云科技区域都有不同的默认KMS密钥。
类型：字符串
必需：否
-
- NewDBClusterIdentifier
-
重命名集群时集群的新集群标识符。此值以一个小写字符串存储。
约束：
-
必须包含 1 到 63 个字母、数字或连字符。
-
第一个字符必须是字母。
-
不能以连字符结束或包含两个连续连字符。
示例：
my-cluster2类型：字符串
必需：否
-
- Port
-
集群接受连接的端口号。
约束：必须是介于
1150到65535的值。默认值：与原始数据库集群相同的端口。
类型：整数
必需：否
- PreferredBackupWindow
-
使用
BackupRetentionPeriod参数启用了自动备份时，自动执行备份的日常时间范围。默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口。 AWS 区域
约束：
-
必须采用
hh24:mi-hh24:mi格式。 -
必须采用通用协调时间 (UTC)。
-
不得与首选维护时段冲突。
-
必须至少为 30 分钟。
类型：字符串
必需：否
-
- PreferredMaintenanceWindow
-
每周可以进行系统维护的时间范围，以通用协调时间 (UTC) 为单位。
格式：
ddd:hh24:mi-ddd:hh24:mi默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域，出现在一周中的随机某一天。
有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun
约束：至少为 30 分钟的时段。
类型：字符串
必需：否
- RotateMasterUserPassword
-
指定是否轮换由 Amazon Web Services Secrets Manager 管理的密钥作为主用户密码。
只有当主用户密码由 Amazon DocumentDB 在集群的 Amazon Web Services Secrets Manager 中管理时，此设置才有效。密钥值包含更新的密码。
约束：轮换主用户密码时，必须立即应用更改。
类型：布尔值
必需：否
- StorageType
-
与数据库集群关联的存储类型。
有关 Amazon DocumentDB 集群存储类型的信息，请参阅《Amazon DocumentDB 开发人员指南》中的集群存储配置。
存储类型的有效值 -
standard | iopt1默认值为
standard类型：字符串
必需：否
- VpcSecurityGroupIds。 VpcSecurityGroupId.N
-
集群将属于的虚拟私有云 (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
- StorageQuotaExceeded
-
该请求会导致您超出跨所有实例可提供的已允许存储量。
HTTP状态码：400
另请参阅
有关API在一种特定语言中使用此功能的更多信息 AWS SDKs，请参阅以下内容：
