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

# 修改 Amazon DocumentDB 集群
<a name="db-cluster-modify"></a>

要修改集群，该集群必须处于 *可用* 状态。您无法修改已停止的集群。如果集群已停止，则首先启动集群，等待集群进入*可用*状态，然后进行所需修改。有关更多信息，请参阅 [停止和启动 Amazon DocumentDB 集群](db-cluster-stop-start.md)。

------
#### [ Using the AWS 管理控制台 ]

通过以下过程使用控制台修改特定的 Amazon DocumentDB 集群。

**修改 Amazon DocumentDB 集群**

1. [登录 AWS 管理控制台，然后在 /docdb 上打开亚马逊文档数据库控制台。https://console.aws.amazon.com](https://console.aws.amazon.com/docdb)

1. 在导航窗格中，选择**集群**。
**提示**  
如果您在屏幕左侧没有看到导航窗格，请在页面左上角选择菜单图标 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/zh_cn/documentdb/latest/developerguide/images/docdb-menu-icon.png))。

1. 通过选择集群名称左侧的按钮，指定要修改的集群。

1. 选择 **Actions (操作)**，然后选择 **Modify (修改)**。

1. 在 **Modify Cluster: cluster-name (修改集群: cluster-name)** 窗格中，进行所需更改。您可以更改以下方面：
   + **集群规范**：集群的名称、安全组和凭证管理。
   + **集群存储配置**：集群的数据存储模式。在“标准配置”和“I/O 优化配置”之间进行选择。
   + **集群选项**：集群的端口和参数组。
   + **备份**：集群的备份留存期和备份时段。
   + **日志导出**：启用或禁用导出审计日志或分析器日志。
   + **维护**：设置集群的维护时段。
   + **删除保护**：对集群启用或禁用删除保护。默认情况下，将启用删除保护。

1. 完成后，选择 **Continue (继续)** 以查看更改摘要。

1. 如果您对所做更改满意，可以选择 **Modify cluster (修改集群)** 以修改集群。或者，您可以选择 **Back (返回)** 或 **Cancel (取消)** 来编辑或取消您的更改。

需要几分钟时间才能应用更改。只有在实例状态为 *available (可用)* 时，才能使用集群。您可以使用控制台或 AWS CLI监控集群状态。有关更多信息，请参阅 [监控 Amazon DocumentDB 集群的状态](monitoring_docdb-cluster_status.md)。

------
#### [ Using the AWS CLI ]

使用 `modify-db-cluster` 操作以使用 AWS CLI修改指定的集群。有关更多信息，请参阅 *Amazon DocumentDB API 参考*中的 [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html)。

**参数**
+ **--db-cluster-identifier**：必填项。您要修改的 Amazon DocumentDB 集群的标识符。
+ **--backup-retention-period**：可选。自动备份的保留天数。有效值为 1-35。
+ **--storage-type**：可选。集群存储配置。有效值为 `standard`（标准）或 `iopt1`（I/O 优化）。
+ **--db-cluster-parameter-group-name**：可选。用于集群的集群参数组的名称。
+ **--manage-master-user-password**：可选。Amazon DocumentDB 会生成主用户密码并在其整个生命周期中在 Secrets Manager 中对其进行管理。
+ **--rotate-master-user-password**：可选。Secrets Manager 会为现有密钥生成一个新的密钥版本。密钥的新版本包含新的主用户密码。Amazon DocumentDB 会更改集群的主用户密码以匹配新密钥版本的密码。

  轮换主密码时必须指定 **--apply-immediately** 选项。
+ **--master-user-password**：可选。主数据库用户的新密码。

  密码约束：
  + 长度为 [8–100] 个可打印 ASCII 字符。
  + 可以使用任何可打印 ASCII 字符，以下字符除外：
    + **/**（正斜杠）
    + **"**（双引号）
    + **@**（@ 符号）
+ **--new-db-cluster-identifier**：可选。重命名集群时集群的新集群标识符。此值以一个小写字符串存储。

  命名约束：
  + 长度为 [1-63] 个字母、数字或连字符。
  + 第一个字符必须是字母。
  + 不能以连字符结尾或包含两个连续的连字符。
  + 每个区域的 Amazon RDS、Amazon Neptune 和 Amazon DocumentDB 中的所有集群都必须是唯一 AWS 账户的。
+ **--preferred-backup-window**：可选。创建自动备份的每日时间范围，以通用协调时间 (UTC) 表示。
  + 格式：`hh24:mm-hh24:mm`
+ **--preferred-maintenance-window**：可选。可能进行系统维护的每周时间范围，以 UTC 表示。
  + 格式：`ddd:hh24:mm-ddd:hh24:mm`
  + 有效值：`Sun`、`Mon`、`Tue`、`Wed`、`Thu`、`Fri` 和 `Sat`。
+ **--deletion-protection** 或 **--no-deletion-protection**：可选。是否应在此集群上启用删除保护。删除保护可以防止集群被意外删除，直到修改集群以禁用删除保护。有关更多信息，请参阅 [删除 Amazon DocumentDB 集群](db-cluster-delete.md)。
+ **--apply-immediately** 或 **--no-apply-immediately**：使用 `--apply-immediately` 可立即进行更改。使用 `--no-apply-immediately` 在集群的下一个维护时段期间进行更改。

**Example**  
以下代码将更改集群 `sample-cluster` 的备份保留期。  
对于 Linux、macOS 或 Unix：  

```
aws docdb modify-db-cluster \
       --db-cluster-identifier sample-cluster \
       --apply-immediately \
       --backup-retention-period 7
```
对于 Windows：  

```
aws docdb modify-db-cluster ^
       --db-cluster-identifier sample-cluster ^
       --apply-immediately ^
       --backup-retention-period 7
```
此操作的输出将类似于下文。  

```
{
    "DBCluster": {
        "BackupRetentionPeriod": 7,
        "DbClusterResourceId": "cluster-VDP53QEWST7YHM36TTXOPJT5YE",
        "Status": "available",
        "DBClusterMembers": [
            {
                "PromotionTier": 1,
                "DBClusterParameterGroupStatus": "in-sync",
                "DBInstanceIdentifier": "sample-cluster-instance",
                "IsClusterWriter": true
            }
        ],
        "ReadReplicaIdentifiers": [],
        "AvailabilityZones": [
            "us-east-1b",
            "us-east-1c",
            "us-east-1a"
        ],
        "ReaderEndpoint": "sample-cluster.cluster-ro-ctevjxdlur57.us-east-1.rds.amazonaws.com",
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
        "PreferredMaintenanceWindow": "sat:09:51-sat:10:21",
        "EarliestRestorableTime": "2018-06-17T00:06:19.374Z",
        "StorageEncrypted": false,
        "MultiAZ": false,
        "AssociatedRoles": [],
        "MasterUsername": "<your-master-user-name>",
        "DBClusterIdentifier": "sample-cluster",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "HostedZoneId": "Z2SUY0A1719RZT",
        "LatestRestorableTime": "2018-06-18T21:17:05.737Z",
        "AllocatedStorage": 1,
        "Port": 27017,
        "Engine": "docdb",
        "DBClusterParameterGroup": "default.docdb3.4",
        "Endpoint": "sample-cluster.cluster-ctevjxdlur57.us-east-1.rds.amazonaws.com",
        "DBSubnetGroup": "default",
        "PreferredBackupWindow": "00:00-00:30",
        "EngineVersion": "3.4",
        "ClusterCreateTime": "2018-06-06T19:25:47.991Z",
        "IAMDatabaseAuthenticationEnabled": false
    }
}
```

需要几分钟时间才能应用更改。只有在实例状态为 *available (可用)* 时，才能使用集群。您可以使用控制台或 AWS CLI监控集群状态。有关更多信息，请参阅 [监控 Amazon DocumentDB 集群的状态](monitoring_docdb-cluster_status.md)。

------