修改 Amazon DocumentDB 集群参数

在 Amazon DocumentDB 中，集群参数组 由参数 组成，这些参数适用于您在集群中创建的所有实例。对于自定义集群参数组，您可以随时修改参数值，或将所创建参数组的所有参数值重置为其默认值。本节介绍如何查看组成 Amazon DocumentDB 集群参数组的参数及其值，以及如何更改或更新这些值。

参数可以是动态或静态的。当您更改动态参数并保存集群参数组时，将立即应用更改，而不管 Apply Immediately 设置如何。当您更改静态参数并保存集群参数组时，参数更改仅在您手动重启实例后生效。

查看 Amazon DocumentDB 集群参数组的参数

使用 AWS 管理控制台 或 AWS CLI 查看 Amazon DocumentDB 集群的参数及妻值。

要查看集群参数组的详细信息

  1. 通过以下网址登录 AWS 管理控制台并打开 Amazon DocumentDB 控制台：https://console.aws.amazon.com/docdb。

  2. 在导航窗格中，选择参数组。

    提示

    如果您在屏幕左侧没有看到导航窗格，请在页面左上角选择菜单图标 (修改集群参数 - 图1)。

  3. 在 Parameter groups (参数组) 窗格中，选择要查看其详细信息的集群参数组的名称。

  4. 生成的页面将显示每个参数的以下值：参数的名称、当前值、允许的值、参数是否可修改、应用类型、数据类型和描述。

    ![

    1.                        屏幕截图：参数名称和值。
    2.                     ](/projects/DocumentDB-20201111-zh/d78edb781bf6f94a52f01ac3501eaf60.png)

要查看集群参数组的参数及其值，请使用带有以下参数的 describe-db-cluster-parameters 操作。

  • --db-cluster-parameter-group-name — 必需。您想要详细参数列表的集群参数组的名称。

  • --source — 可选。如果提供特定源，仅返回参数。参数源可以是 engine-default、system 或 user。

以下代码列出了 custom3-6-param-grp 参数组的所有参数及其值。有关参数组的更多信息，请省略 --query 行。有关所有参数组的信息，请省略 --db-cluster-parameter-group-name 行。

对于 Linux、macOS 或 Unix:

  1. aws docdb describe-db-cluster-parameters \
  2.    --db-cluster-parameter-group-name custom3-6-param-grp \
  3.    --query 'Parameters[*].[ParameterName,ParameterValue]'

对于 Windows:

  1. aws docdb describe-db-cluster-parameters ^
  2.    --db-cluster-parameter-group-name custom3-6-param-grp ^
  3.    --query 'Parameters[*].[ParameterName,ParameterValue]'

此操作的输出将类似于下文（JSON 格式）。

  1. [
  2.     [
  3.         "audit_logs",
  4.         "disabled"
  5.     ],
  6.     [
  7.         "tls",
  8.         "enabled"
  9.     ],
  10.     [
  11.         "ttl_monitor",
  12.         "enabled"
  13.     ]
  14. ]

修改 Amazon DocumentDB 集群参数组的参数

您可以使用 AWS 管理控制台或 AWS CLI 修改参数组的参数。

更新集群参数组的参数

  1. 通过以下网址登录 AWS 管理控制台并打开 Amazon DocumentDB 控制台：https://console.aws.amazon.com/docdb。

  2. 在导航窗格中，选择参数组。

    提示

    如果您在屏幕左侧没有看到导航窗格，请在页面左上角选择菜单图标 (修改集群参数 - 图2)。

  3. 在 Parameter groups （参数组） 窗格中，选择要为其更新参数的集群参数组。

  4. 生成的页面显示此集群参数组的参数及其相应的详细信息。选择要更新的参数。

  5. 在页面右上角，选择编辑以更改参数的值。有关集群参数的类型的更多信息，请参阅Amazon DocumentDB 集群参数参考。

  6. 进行更改，然后选择 Modify cluster parameter （修改集群参数） 以保存更改。要放弃更改，请选择 Cancel （取消）。

要修改集群参数组的参数，请使用带以下参数的 modify-db-cluster-parameter-group 操作：

  • --db-cluster-parameter-group-name — 必需。您正在修改的集群参数组的名称。

  • --parameters — 必需。您正在修改的参数。每个参数条目必须包含以下内容：

    • ParameterName — 您正在修改的参数的名称。

    • ParameterValue — 此参数的新值。

    • ApplyMethod — 您希望如何对应用的参数进行更改。允许的值为 immediate 和 pending-reboot。

      注意

      具有 ApplyType 的 static 参数必须具有 ApplyMethod 的 pending-reboot。

更改集群参数组的参数的值 （AWS CLI）

以下示例将更改 tls 参数。

  1. 列出 的参数及其值 sample-parameter-group

    对于 Linux、macOS 或 Unix:

    1. aws docdb describe-db-cluster-parameters \
    2.     --db-cluster-parameter-group-name sample-parameter-group

    对于 Windows:

    1. aws docdb describe-db-cluster-parameters ^
    2.     --db-cluster-parameter-group-name sample-parameter-group

    此操作的输出将类似于下文（JSON 格式）。

    1. {
    2.     "Parameters": [
    3.         {
    4.             "Source": "system",
    5.             "ApplyType": "static",
    6.             "AllowedValues": "disabled,enabled",
    7.             "ParameterValue": "enabled",
    8.             "ApplyMethod": "pending-reboot",
    9.             "DataType": "string",
    10.             "ParameterName": "tls",
    11.             "IsModifiable": true,
    12.             "Description": "Config to enable/disable TLS"
    13.         },
    14.         {
    15.             "Source": "user",
    16.             "ApplyType": "dynamic",
    17.             "AllowedValues": "disabled,enabled",
    18.             "ParameterValue": "enabled",
    19.             "ApplyMethod": "pending-reboot",
    20.             "DataType": "string",
    21.             "ParameterName": "ttl_monitor",
    22.             "IsModifiable": true,
    23.             "Description": "Enables TTL Monitoring"
    24.         }
    25.     ]
    26. }

  2. 修改 tls 参数，使其值为 disabled。 您无法修改 ApplyMethod，因为 ApplyType 是 static。

    对于 Linux、macOS 或 Unix:

    1. aws docdb modify-db-cluster-parameter-group \
    2.     --db-cluster-parameter-group-name sample-parameter-group \
    3.     --parameters "ParameterName"=tls,ParameterValue=disabled,ApplyMethod=pending-reboot"

    对于 Windows:

    1. aws docdb modify-db-cluster-parameter-group ^
    2.     --db-cluster-parameter-group-name sample-parameter-group ^
    3.     --parameters "ParameterName=tls,ParameterValue=disabled,ApplyMethod=pending-reboot"

    此操作的输出将类似于下文（JSON 格式）。

    1. {
    2.     "DBClusterParameterGroupName": "sample-parameter-group"
    3. }

  3. 等待至少 5 分钟。

  4. 列出 sample-parameter-group 的参数值。

    对于 Linux、macOS 或 Unix:

    1. aws docdb describe-db-cluster-parameters \
    2.     --db-cluster-parameter-group-name sample-parameter-group

    对于 Windows:

    1. aws docdb describe-db-cluster-parameters ^
    2.     --db-cluster-parameter-group-name sample-parameter-group

    此操作的输出将类似于下文（JSON 格式）。

    1. {
    2.     "Parameters": [
    3.         {
    4.             "ParameterName": "audit_logs",
    5.             "ParameterValue": "disabled",
    6.             "Description": "Enables auditing on cluster.",
    7.             "Source": "system",
    8.             "ApplyType": "dynamic",
    9.             "DataType": "string",
    10.             "AllowedValues": "enabled,disabled",
    11.             "IsModifiable": true,
    12.             "ApplyMethod": "pending-reboot"
    13.         },
    14.         {
    15.             "ParameterName": "tls",
    16.             "ParameterValue": "disabled",
    17.             "Description": "Config to enable/disable TLS",
    18.             "Source": "user",
    19.             "ApplyType": "static",
    20.             "DataType": "string",
    21.             "AllowedValues": "disabled,enabled",
    22.             "IsModifiable": true,
    23.             "ApplyMethod": "pending-reboot"
    24.         }
    25.     ]
    26. }