修改 Amazon DocumentDB 集群参数组 - Amazon DocumentDB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

修改 Amazon DocumentDB 集群参数组

本节介绍如何修改自定义 Amazon DocumentDB 参数组。在 Amazon DocumentDB 中，您不能修改自己使用新引擎版本在新区域首次创建集群时所创建的 default 集群参数组。如果您的 Amazon DocumentDB 集群正使用默认集群参数组，而您想要修改其中的值，则您必须首先创建新的参数组或复制现有参数组，修改它，并且将修改的参数组应用于您的集群。

请完成以下步骤以修改自定义集群参数组。修改操作可能耗费一段时间来传播。请等待修改的集群参数组变为可用，之后将其附加到您的集群。您可以使用 Amazon Web Services Management Console 或 Amazon CLI describe-db-cluster-parameters 操作来验证您的集群参数组是否已修改。有关更多信息，请参阅 描述集群参数组。

Using the Amazon Web Services Management Console

遵循以下步骤修改自定义 Amazon DocumentDB 参数组。您无法修改 default 参数组。如果要修改 default 参数组中的值，您可以复制默认的集群参数组，修改它，然后将修改后的参数组应用于您的集群。有关将参数组应用于您的集群的更多信息，请参阅 修改 Amazon DocumentDB 集群。

修改自定义集群参数组

  1. 登录到 Amazon Web Services Management Console 并打开 Amazon DocumentDB 控制台，网址：https://console.aws.amazon.com/docdb。

  2. 在控制台左侧的导航窗格中，选择参数组。在参数组列表中，选择要修改的参数组的名称。

    提示

    如果您在屏幕左侧没有看到导航窗格，请在页面左上角选择菜单图标 (Hamburger menu icon with three horizontal lines.)。

  3. 对于要修改的参数组中的每个参数，执行以下操作：

    1. 找到要修改的参数，并通过核查该参数是否在可修改列下作为 true 列出，验证该参数是否可修改。

    2. 如果该参数可修改，请选择它并从控制台页面的右上角选择编辑。

    3. 在修改 <parameter-name> 对话框中，进行所需的更改。然后，选择 Modify cluster parameter (修改集群参数) 或选择 Cancel (取消) 以放弃更改。

Using the Amazon CLI

您可以使用 Amazon CLI，修改 Amazon DocumentDB 集群参数组中任何可修改参数的 ParameterValue、Description 或 ApplyMethod。您无法直接对默认的集群参数组进行修改。

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

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

  • --parameters – 必需。您正在修改的参数。有关适用于 Amazon DocumentDB 集群中所有实例的参数列表，请参阅 Amazon DocumentDB 集群参数参考。每个参数条目必须包含以下内容：

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

    • ParameterValue — 此参数的新值。

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

      注意

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

例 - 修改参数的值

在此示例中，您列出 sample-parameter-group 的参数值并修改 tls 参数。然后，等待 5 分钟后，再次列出 sample-parameter-group 的参数值以查看更改后的参数值。

  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"
           }
       ]
}

  2. 修改 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"
   }

  3. 至少等 5 分钟。

  4. 列出 sample-parameter-group 的参数值以验证 tls 参数是否修改过。

    对于 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": [
           {
               "ParameterValue": "false",
               "ParameterName": "enable_audit_logs",
               "ApplyType": "dynamic",
               "DataType": "string",
               "Description": "Enables auditing on cluster.",
               "AllowedValues": "true,false",
               "Source": "system",
               "IsModifiable": true,
               "ApplyMethod": "pending-reboot"
           },
           {
               "ParameterValue": "disabled",
               "ParameterName": "tls",
               "ApplyType": "static",
               "DataType": "string",
               "Description": "Config to enable/disable TLS",
               "AllowedValues": "disabled,enabled",
               "Source": "system",
               "IsModifiable": true,
               "ApplyMethod": "pending-reboot"
           }
       ]
}