Amazon DocumentDB クラスターパラメータグループを変更する - Amazon DocumentDB

Amazon DocumentDB クラスターパラメータグループを変更する

このセクションでは、カスタム Amazon DocumentDB パラメータグループを変更する方法について説明します。Amazon DocumentDB では、新しいリージョンで新しいエンジンバージョンでクラスターを初めて作成したときに作成された default クラスターパラメータグループを変更することはできません。Amazon DocumentDB クラスターがデフォルトのクラスターパラメータグループを使用していて、その中の値を変更する場合は、まず 新しいパラメータグループを作成 するか、既存のパラメータグループをコピーし、それを変更してから、変更されたパラメータグループをクラスターに適用します。

カスタムクラスターパラメータグループを変更するには、以下のステップを実行します。変更アクションが反映されるまでに時間がかかる場合があります。変更したクラスターパラメータグループが使用可能になるのを待ってから、クラスターにアタッチしてください。AWS Management Console または AWS CLI describe-db-cluster-parameters オペレーションを使用して、クラスターパラメータグループが変更されたことを確認できます。詳細については、「クラスターパラメータグループの説明」を参照してください。

Using the AWS Management Console

以下のステップに従って、カスタム Amazon DocumentDB パラメータグループを変更します。default パラメータグループを変更することはできません。default パラメータグループの値を変更する場合は、デフォルトのパラメータグループをコピーして、変更し、次に変更したパラメータグループをクラスターに適用します。クラスターへのパラメータグループの適用の詳細については、「Amazon DocumentDB クラスターの変更」を参照してください。

カスタムのクラスターパラメータグループを変更するには

  1. AWS 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> の変更] ダイアログボックスで、必要な変更を行います。次に、[クラスターパラメータの変更] を選択するか、[キャンセル] を選択して変更を破棄します。

Using the AWS CLI

カスタムAmazon DocumentDB クラスターパラメータグループの変更可能なパラメータの ParameterValue、Description、または ApplyMethod は、AWS CLI を使用して変更することができます。デフォルトのクラスターパラメータグループに対して直接変更を加えることはできません。

カスタムクラスターパラメータグループのパラメータを変更するには、以下のパラメータを指定して modify-db-cluster-parameter-group オペレーションを使用します。

  • --db-cluster-parameter-group-name — 必須。変更するクラスターパラメータグループの名前。

  • --parameters — 必須。変更するパラメータ。Amazon DocumentDB クラスター内のすべてのインスタンスに適用されるパラメータの一覧は、Amazon DocumentDB クラスターパラメータリファレンス を参照してください。各パラメータの入力には以下を含める必要があります。

    • ParameterName - 変更するパラメータの名前です。

    • ParameterValue - このパラメータの新しい値です。

    • ApplyMethod - このパラメータの変更を適用する方法です。有効な値は、immediate および pending-reboot です。

      注記

      ApplyType が static であるパラメータでは、ApplyMethod が pending-reboot である必要があります。

例 - パラメータの値を変更する

この例では、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 になるようにします。

    ApplyType が static であるため、ApplyMethod を変更することはできません。

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