本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# 修改 Amazon DocumentDB 集群参数
在 Amazon DocumentDB 中，*集群参数组*由适用于您在该集群中创建的所有实例的*参数*组成。对于自定义集群参数组，您可以随时修改参数值，也可以将所有参数值重置为您创建的参数组的默认值。本节介绍如何查看构成 Amazon DocumentDB 集群参数组的参数及其值，以及您可以如何更改或更新这些值。
参数可以是*动态*或*静态*的。当您更改动态参数并保存集群参数组时，更改将立即应用，而不管 `Apply Immediately` 的设置如何。当您更改静态参数并保存集群参数组时，参数更改仅在您手动重启实例后生效。
## 查看 Amazon DocumentDB 集群参数组的参数
您可以使用或查看 Amazon DocumentDB 集群的参数及其值。 AWS 管理控制台 AWS CLI
------
#### [ Using the AWS 管理控制台 ]
**要查看集群参数组的详细信息**
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. 在 **Parameter groups (参数组)** 窗格中，选择要查看其详细信息的集群参数组的名称。
1. 生成的页面显示每个参数的以下值：参数的名称、当前值、允许的值、参数是否可修改、应用类型、数据类型和描述。
![\[屏幕截图：参数名称和值。\]](http://docs.aws.amazon.com/zh_cn/documentdb/latest/developerguide/images/docdb-determine-parameter-value.png)
------
#### [ Using the AWS CLI ]
要查看集群参数组的参数及其值，请使用带有以下参数的 `describe-db-cluster-parameters` 操作。
+ **--db-cluster-parameter-group-name**：必需。您想要详细参数列表的集群参数组的名称。
+ **--source**：可选。如果提供特定源，仅返回参数。参数源可以是 `engine-default`、`system` 或 `user`。
**Example**
以下代码列出了 `custom3-6-param-grp` 参数组的所有参数及其值。有关参数组的更多信息，请省略 `--query` 行。有关所有参数组的信息，请省略 `--db-cluster-parameter-group-name` 行。
对于 Linux、macOS 或 Unix：
```
aws docdb describe-db-cluster-parameters \
--db-cluster-parameter-group-name custom3-6-param-grp \
--query 'Parameters[*].[ParameterName,ParameterValue]'
```
对于 Windows：
```
aws docdb describe-db-cluster-parameters ^
--db-cluster-parameter-group-name custom3-6-param-grp ^
--query 'Parameters[*].[ParameterName,ParameterValue]'
```
此操作的输出将类似于下文（JSON 格式）。
```
[
[
"audit_logs",
"disabled"
],
[
"tls",
"enabled"
],
[
"ttl_monitor",
"enabled"
]
]
```
------
## 修改 Amazon DocumentDB 集群参数组的参数
您可以使用 AWS 管理控制台 或修改参数组的参数 AWS CLI。
------
#### [ Using the AWS 管理控制台 ]
**要更新集群参数组的参数**
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. 所得页面显示该集群参数组的参数及它们的相应详情。选择要更新的参数。
1. 在页面右上角，选择**编辑**以更改参数的值。有关集群参数类型的更多信息，请参阅 [Amazon DocumentDB 集群参数参考](cluster_parameter_groups-list_of_parameters.md)。
1. 进行更改，然后选择**修改集群参数**以保存更改。要放弃更改，请选择**取消**。
------
#### [ Using the AWS CLI ]
要修改集群参数组的参数，请使用带以下参数的 `modify-db-cluster-parameter-group` 操作：
+ **--db-cluster-parameter-group-name**：必需。您正在修改的集群参数组的名称。
+ **--parameters**：必需。您正在修改的参数。每个参数条目必须包含以下内容：
+ **ParameterName**：您正在修改的参数的名称。
+ **ParameterValue**：此参数的新值。
+ **ApplyMethod**：您希望如何应用对此参数的更改。允许的值为 `immediate` 和 `pending-reboot`。
**注意**
带 `static` 的 `ApplyType` 参数必须具有 `pending-reboot` 的 `ApplyMethod`。
**更改集群参数组参数 (AWS CLI) 的值**
以下示例将更改 `tls` 参数。
1. **列出 `sample-parameter-group`** 的参数及其值。
对于 Linux、macOS 或 Unix：
```
aws docdb describe-db-cluster-parameters \
--db-cluster-parameter-group-name sample-parameter-group
```
对于 Windows：
```
aws docdb describe-db-cluster-parameters ^
--db-cluster-parameter-group-name sample-parameter-group
```
此操作的输出将类似于下文（JSON 格式）。
```
{
"Parameters": [
{
"Source": "system",
"ApplyType": "static",
"AllowedValues": "disabled,enabled",
"ParameterValue": "enabled",
"ApplyMethod": "pending-reboot",
"DataType": "string",
"ParameterName": "tls",
"IsModifiable": true,
"Description": "Config to enable/disable TLS"
},
{
"Source": "user",
"ApplyType": "dynamic",
"AllowedValues": "disabled,enabled",
"ParameterValue": "enabled",
"ApplyMethod": "pending-reboot",
"DataType": "string",
"ParameterName": "ttl_monitor",
"IsModifiable": true,
"Description": "Enables TTL Monitoring"
}
]
}
```
1. **修改 `tls` 参数，以便其值为 `disabled`**。您无法修改 `ApplyMethod`，因为 `ApplyType` 是 `static`。
对于 Linux、macOS 或 Unix：
```
aws docdb modify-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group \
--parameters "ParameterName"=tls,ParameterValue=disabled,ApplyMethod=pending-reboot"
```
对于 Windows：
```
aws docdb modify-db-cluster-parameter-group ^
--db-cluster-parameter-group-name sample-parameter-group ^
--parameters "ParameterName=tls,ParameterValue=disabled,ApplyMethod=pending-reboot"
```
此操作的输出将类似于下文（JSON 格式）。
```
{
"DBClusterParameterGroupName": "sample-parameter-group"
}
```
1. **至少等 5 分钟。**
1. **列出 `sample-parameter-group` 的参数值。**
对于 Linux、macOS 或 Unix：
```
aws docdb describe-db-cluster-parameters \
--db-cluster-parameter-group-name sample-parameter-group
```
对于 Windows：
```
aws docdb describe-db-cluster-parameters ^
--db-cluster-parameter-group-name sample-parameter-group
```
此操作的输出将类似于下文（JSON 格式）。
```
{
"Parameters": [
{
"ParameterName": "audit_logs",
"ParameterValue": "disabled",
"Description": "Enables auditing on cluster.",
"Source": "system",
"ApplyType": "dynamic",
"DataType": "string",
"AllowedValues": "enabled,disabled",
"IsModifiable": true,
"ApplyMethod": "pending-reboot"
},
{
"ParameterName": "tls",
"ParameterValue": "disabled",
"Description": "Config to enable/disable TLS",
"Source": "user",
"ApplyType": "static",
"DataType": "string",
"AllowedValues": "disabled,enabled",
"IsModifiable": true,
"ApplyMethod": "pending-reboot"
}
]
}
```
------