查看亚马逊 DocumentDB 集群参数组的参数修改亚马逊 DocumentDB 集群参数组的参数

修改亚马逊文档数据库集群参数

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

参数可以是动态或静态的。当您更改动态参数并保存群集参数组时，无论发生何种情况，都会立即应用更改Apply Immediately设置。当您更改静态参数并保存集群参数组时，参数更改仅在您手动重启实例后生效。

查看亚马逊 DocumentDB 集群参数组的参数

您可以使用查看 Amazon DocumentDB 集群的参数及其值Amazon Web Services Management Console要么Amazon CLI。

Using the Amazon Web Services Management Console

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

登录Amazon Web Services Management Console，然后打开亚马逊 DocumentDB 控制台，网址为https://console.aws.amazon.com/docdb。
在导航窗格中，选择参数组。

提示
如果您在屏幕左侧没有看到导航窗格，请在页面左上角选择菜单图标 ()。
在 Parameter groups (参数组) 窗格中，选择要查看其详细信息的集群参数组的名称。
结果页面显示每个参数的以下值：参数的名称、当前值、允许的值、参数是否可修改、应用类型、数据类型和描述。

Using the Amazon CLI

要查看集群参数组的参数及其值，请使用带有以下参数的 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：


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

修改亚马逊 DocumentDB 集群参数组的参数

您可以使用修改参数组的参数Amazon Web Services Management Console要么Amazon CLI。

Using the Amazon Web Services Management Console

更新群集参数组的参数

登录Amazon Web Services Management Console，然后打开亚马逊 DocumentDB 控制台，网址为https://console.aws.amazon.com/docdb。
在导航窗格中，选择参数组。

提示
如果您在屏幕左侧没有看到导航窗格，请在页面左上角选择菜单图标 ()。
在参数组窗格中，选择要更新其参数的集群参数组。
结果页面显示此集群参数组的参数及其相应详细信息。选择要更新的参数。
在页面右上角，选择编辑以更改参数的值。有关群集参数类型的更多信息，请参阅亚马逊文档数据库集群参数参考。
进行更改，然后选择修改集群参数保存更改。要放弃您的更改，请选择取消。

Using the Amazon CLI

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

--db-cluster-parameter-group-name – 必需。您正在修改的集群参数组的名称。
--parameters – 必需。您正在修改的参数。每个参数条目必须包含以下内容：
- ParameterName-您正在修改的参数的名称。
- ParameterValue— 此参数的新值。
- ApplyMethod— 您希望如何应用对此参数的更改。允许的值为 immediate 和 pending-reboot。
  
  注意
  带 static 的 ApplyType 参数必须具有 pending-reboot 的 ApplyMethod。

要更改群集参数组的参数值 (Amazon CLI)

以下示例将更改 tls 参数。

列出参数及其值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"
        }
    ]
}

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

至少等待 5 分钟。

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

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

集群参数参考

了解终端节点

修改亚马逊文档数据库集群参数

查看亚马逊 DocumentDB 集群参数组的参数

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

提示

修改亚马逊 DocumentDB 集群参数组的参数

更新群集参数组的参数

提示

注意

要更改群集参数组的参数值 (Amazon CLI)