翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# Amazon DocumentDB クラスターパラメータグループの管理
<a name="cluster_parameter_groups"></a>

クラスターパラメータグループのパラメータを使用して Amazon DocumentDB エンジンの設定を管理できます。*クラスターパラメータグループ* は、Amazon DocumentDB クラスターのパラメータ管理を容易にする Amazon DocumentDB の設定値のコレクションです。クラスターパラメータグループは、クラスター内のすべてのインスタンスに適用されるエンジン設定値のコンテナとして機能します。

このセクションでは、クラスターパラメータグループを作成、表示、および変更する方法について説明します。また、任意のクラスターに関連付けられているクラスターパラメータグループを判別する方法も示します。

**Topics**
+ [クラスターパラメータグループの説明](cluster_parameter_groups-describe.md)
+ [クラスターパラメータグループの作成](cluster_parameter_groups-create.md)
+ [クラスターパラメータグループの変更](cluster_parameter_groups-modify.md)
+ [カスタマイズしたクラスターパラメータグループを使用するためのクラスターの変更](cluster_parameter_groups-modify_clusters.md)
+ [クラスターパラメータグループのコピー](cluster_parameter_groups-copy.md)
+ [クラスターパラメータグループのリセット](cluster_parameter_groups-reset.md)
+ [クラスターパラメータグループの削除](cluster_parameter_groups-delete.md)
+ [クラスターパラメータリファレンス](cluster_parameter_groups-list_of_parameters.md)

# Amazon DocumentDB クラスターパラメータグループについて説明します。
<a name="cluster_parameter_groups-describe"></a>

`default` クラスターパラメータグループは、新しいリージョンで最初の Amazon DocumentDB クラスターを作成するとき、または新しいエンジンを使用するときに自動的に作成されます。同じリージョンで作成され、同じエンジンバージョンを使用する後続のクラスターは、`default` クラスターパラメータグループを使用して作成されます。

**Topics**
+ [クラスターパラメータグループの詳細情報の説明](#cluster_parameter_groups-describe_details)
+ [クラスターのパラメータグループの確認](#cluster_parameter_groups-determine)
+ [クラスターパラメータグループに関連付けられたクラスターとインスタンスの決定](#cluster_parameter_groups-count)

## Amazon DocumentDB クラスターパラメータグループの詳細について説明します。
<a name="cluster_parameter_groups-describe_details"></a>

特定のクラスターパラメータグループの詳細を記述するには、 AWS マネジメントコンソール または AWS Command Line Interface () を使用して次の手順を実行しますAWS CLI。

------
#### [ Using the AWS マネジメントコンソール ]

****

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. ナビゲーションペインで、**[パラメータグループ]** を選択します。
**ヒント**  
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。

1. [**クラスターパラメータグループ**] ペインで、詳細情報を表示するパラメータグループの名前を選択します。

1. 表示されるページには、パラメータグループのパラメータ、最近のアクティビティ、タグが表示されます。
   + [**クラスターパラメータ**] には、パラメータの名前、現在の値、許容値、パラメータが変更可能かどうか、適用タイプ、データタイプ、説明が表示されます。個々のパラメータを修正するには、パラメータを選択し、**クラスターパラメータ** セクションの**編集** を選択します。詳細については、「[Amazon DocumentDB クラスターパラメータを変更する](cluster_parameter_groups-parameters.md)」を参照してください。
   + [**最近のイベント**] で、このパラメータグループの最新のイベントを確認できます。このセクションの検索バーを使用して、これらのイベントをフィルタリングできます。詳細については、「[Amazon DocumentDB イベントの管理](managing-events.md)」を参照してください。
   + [**タグ**] で、このクラスターパラメータグループのタグを表示できます。タグを追加、または削除するには、**編集** を **タグ** のセクションで選択します。詳細については、「[Amazon DocumentDB リソースへのタグ付け](tagging.md)」を参照してください。

------
#### [ Using the AWS CLI ]

`describe-db-cluster-parameter-groups` AWS CLI コマンドを使用して、Amazon DocumentDB 用の単一のクラスターパラメータグループまたはすべてのクラスターパラメータグループの Amazon リソースネーム (ARN)、ファミリー、説明、および名前を表示できます。`describe-db-cluster-parameters` AWS CLI コマンドを使用して、単一のクラスターパラメータグループ内のパラメータとその詳細を表示することもできます。
+ **--describe-db-cluster-parameter-groups** - すべてのクラスターパラメータグループとその詳細の一覧を表示するには。
  + **--db-cluster-parameter-group-name** - オプション。説明するクラスターパラメータグループの名前。このパラメータを省略した場合、すべてのクラスターパラメータグループが説明されます。
+ **--describe-db-cluster-parameters** - パラメータグループ内のすべてのパラメータとその詳細の一覧を表示するには。
  + **--db-cluster-parameter-group name** — 必須。説明するクラスターパラメータグループの名前。

**Example**  
次のコードは、最大 100 のクラスターパラメータグループと、その ARN、ファミリー、説明、および名前を表示します。  

```
aws docdb describe-db-cluster-parameter-groups
```
このオペレーションによる出力は、次のようになります (JSON 形式)。  

```
{
          "DBClusterParameterGroups": [
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:default.docdb4.0",
                  "DBParameterGroupFamily": "docdb4.0",
                  "Description": "Default cluster parameter group for docdb4.0",
                  "DBClusterParameterGroupName": "default.docdb4.0"
              },
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:sample-parameter-group",
                  "DBParameterGroupFamily": "docdb4.0",
                  "Description": "Custom docdb4.0 parameter group",
                  "DBClusterParameterGroupName": "sample-parameter-group"
              }
          ]
}
```

**Example**  
次のコードは、`sample-parameter-group` の ARN、ファミリー、説明、および名前を示しています。  
Linux、macOS、Unix の場合:  

```
aws docdb describe-db-cluster-parameter-groups \
          --db-cluster-parameter-group-name sample-parameter-group
```
Windows の場合:  

```
aws docdb describe-db-cluster-parameter-groups ^
          --db-cluster-parameter-group-name sample-parameter-group
```
このオペレーションによる出力は、次のようになります (JSON 形式)。  

```
{
          "DBClusterParameterGroups": [
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group",
                  "Description": "Custom docdb4.0 parameter group",
                  "DBParameterGroupFamily": "docdb4.0",
                  "DBClusterParameterGroupName": "sample-parameter-group"
              }
          ]
}
```

**Example**  
次のコードは、`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": "change_stream_log_retention_duration",
            "ParameterValue": "17777",
            "Description": "Duration of time in seconds that the change stream log is retained and can be consumed.",
            "Source": "user",
            "ApplyType": "dynamic",
            "DataType": "integer",
            "AllowedValues": "3600-86400",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot"
         }
   ]
}
```

------

## Amazon DocumentDB クラスターのパラメータグループの確認をする
<a name="cluster_parameter_groups-determine"></a>

特定のクラスターに関連付けられているパラメータグループを確認するには、 AWS マネジメントコンソール または を使用して次の手順を実行します AWS CLI。

------
#### [ Using the AWS マネジメントコンソール ]

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. 左のナビゲーションペインで **[クラスター]** を選択します。

1. クラスターの一覧で、関心のあるクラスターの名前を選択します。

1. 結果のページには、選択したクラスターの詳細が表示されます。[**クラスターの詳細**] まで下にスクロールします。そのセクションの下部で、[**クラスターパラメータグループ**] の下にパラメータグループの名前を見つけます。  
![\[スクリーンショット: クラスターのパラメータグループの表示。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-determine-parameter-group.png)

------
#### [ Using the AWS CLI ]

次の AWS CLI コードは、クラスター を管理しているパラメータグループを決定します`sample-cluster`。

```
aws docdb describe-db-clusters \
      --db-cluster-identifier sample-cluster \
      --query 'DBClusters[*].[DBClusterIdentifier,DBClusterParameterGroup]'
```

このオペレーションによる出力は、次のようになります (JSON 形式)。

```
[
       [
           "sample-cluster",
           "sample-parameter-group"
       ]
]
```

------

## Amazon DocumentDB クラスターパラメータグループに関連付けられたクラスターとインスタンスの決定
<a name="cluster_parameter_groups-count"></a>

各パラメータグループに関連付けられているクラスターとインスタンスの数を確認するには、 を使用して次の手順を実行します AWS CLI。

------
#### [ Using the AWS CLI ]

次の AWS CLI コードは、 に関連付けられているクラスターとインスタンスの数を決定します`sample-parameter-group`。

Linux、macOS、Unix の場合:

```
aws docdb describe-db-clusters \
      --query 'DBClusters[*].[DBClusterParameterGroup,DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]' \
      --output json | \
      jq -r 'group_by(.[0]) | map({
         parameter_group_name: .[0][0],
         total_clusters: length,
         total_instances: map(.[2] | length) | add // 0
      }) | .[]'
```

Windows の場合:

```
aws docdb describe-db-clusters ^
      --query 'DBClusters[*].[DBClusterParameterGroup,DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]' ^
      --output json | ^
      jq -r 'group_by(.[0]) | map({
         parameter_group_name: .[0][0],
         total_clusters: length,
         total_instances: map(.[2] | length) | add // 0
      }) | .[]'
```

このオペレーションによる出力は、次のようになります (JSON 形式)。

```
{
   "parameter_group_name": "sample-parameter-group",
   "total_clusters": 50,
   "total_instances": 150
}
```

------

# Amazon DocumentDB クラスターパラメータグループを作成する
<a name="cluster_parameter_groups-create"></a>

`default.docdb5.0`、`default.docdb4.0`、`default.docdb3.6` などのデフォルトのクラスターパラメータグループは、新しいエンジンバージョンを使って新しいリージョンでクラスターを作成したときに作成されます。このリージョンで同じエンジンバージョンを使用して作成された後続のクラスターは、`default` クラスターパラメータグループを継承します。一度作成した `default` パラメータグループは、削除したり名前を変更したりすることはできません。設定したパラメータ値を使用してカスタムパラメータグループを作成し、それを Amazon DocumentDB クラスターにアタッチすることで、クラスターインスタンスのエンジン動作を変更できます。

次の手順では、 カスタムクラスターパラメータグループを作成する方法について説明します。その後、[そのパラメータグループ内のパラメータを変更できます](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-modify.html)。

**注記**  
クラスターパラメータグループの作成後、その特定のパラメータグループを使用するまで、5 分以上お待ちください。これにより、クラスターパラメーターグループが新しいクラスターに使用される前に、Amazon DocumentDB が `create` アクションを完全に完了させることができます。 AWS マネジメントコンソール または `describe-db-cluster-parameter-groups` AWS CLI オペレーションを使用して、クラスターパラメータグループが作成されたことを確認できます。詳細については、「[Amazon DocumentDB クラスターパラメータグループについて説明します。](cluster_parameter_groups-describe.md)」を参照してください。

------
#### [ Using the AWS マネジメントコンソール ]

**クラスターパラメータグループを作成するには**

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. ナビゲーションペインで、**[パラメータグループ]** を選択します。
**ヒント**  
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。

1. [**クラスターパラメータグループ**] ペインで、[**作成**] を選択します。

1. [**クラスターパラメータグループの作成**] ペインで、次のように入力します。

   1. **新しいクラスターパラメータグループ名** - クラスターパラメーターグループの名前を入力します。例えば、`sample-parameter-group`。クラスターパラメータグループには、次のような命名に関する制約があります。
      + 長さは [1 ～ 255] 個の英数字です。
      + 1 字目は英字である必要があります。
      + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。

   1. **ファミリー** — クラスターに使用する DocumentDB バージョンを選択します。

   1. **説明** - このクラスターパラメーターグループの説明を入力します。

1. クラスターパラメータグループを作成するには、[**作成**] を選択します。操作をキャンセルするには、[**キャンセル**] を選択します。

1. [**作成**] を選択すると、ページの上部に次のテキストが表示され、クラスターパラメータグループが正常に作成されたことを確認できます。

   ```
   Successfully created cluster parameter group 'sample-parameter-group'.
   ```

------
#### [ Using the AWS CLI ]

Amazon DocumentDB 4.0 クラスターの新しいクラスターパラメータグループを作成するには、以下のパラメータを指定して オペレーションを使用します AWS CLI `create-db-cluster-parameter-group`。
+ **--db-cluster-parameter-group-name** - カスタムクラスターパラメータグループの名前です。例えば、`sample-parameter-group`。
+ **--db-cluster-parameter-group-family** - カスタムクラスターパラメータグループのテンプレートとして使用されるクラスターパラメーターグループファミリーです。
+ **--description** - このクラスターパラメータグループのユーザーが提供する説明です。次の例では、「`Custom docdb4.0 parameter group`」を使用しています。

Linux、macOS、Unix の場合:

**Example**  

```
aws docdb create-db-cluster-parameter-group \
 --db-cluster-parameter-group-name sample-parameter-group \
 --db-parameter-group-family docdb5.0 \
 --description "Custom docdb5.0 parameter group"
```
Windows の場合:  

```
aws docdb create-db-cluster-parameter-group ^
 --db-cluster-parameter-group-name sample-parameter-group ^
 --db-parameter-group-family docdb5.0 ^
 --description "Custom docdb5.0 parameter group"
```
このオペレーションによる出力は、次のようになります (JSON 形式)。  

```
{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "sample-parameter-group",
        "DBParameterGroupFamily": "docdb5.0",
        "Description": "Custom docdb4.0 parameter group",
        "DBClusterParameterGroupArn": "sample-parameter-group-arn"
    }
}
```

------

# Amazon DocumentDB クラスターパラメータグループを変更する
<a name="cluster_parameter_groups-modify"></a>

このセクションでは、*カスタム* Amazon DocumentDB パラメータグループを変更する方法について説明します。Amazon DocumentDB では、新しいリージョンで新しいエンジンバージョンでクラスターを初めて作成したときに作成された `default` クラスターパラメータグループを変更することはできません。Amazon DocumentDB クラスターがデフォルトのクラスターパラメータグループを使用していて、その中の値を変更する場合は、まず [新しいパラメータグループを作成](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-create.html) するか、[既存のパラメータグループをコピーし](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-copy.html)、それを変更してから、変更されたパラメータグループをクラスターに適用します。

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

------
#### [ Using the AWS マネジメントコンソール ]

以下のステップに従って、カスタム Amazon DocumentDB パラメータグループを変更します。`default` パラメータグループを変更することはできません。`default` パラメータグループの値を変更する場合は、[デフォルトのパラメータグループをコピーして](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-copy.html)、変更し、次に変更したパラメータグループをクラスターに適用します。クラスターへのパラメータグループの適用の詳細については、「[Amazon DocumentDB クラスターの変更](db-cluster-modify.md)」を参照してください。

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

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. コンソールの左側のナビゲーションペインで、[**パラメータグループ**] を選択します。パラメータグループのリストで、変更するパラメータグループの名前を選択します。
**ヒント**  
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。

1. 変更するパラメータグループの各パラメータに対して、以下の操作を行います。

   1. 修正したいパラメータを探し、**変更可能** 列の下に `true` としてリストされているかどうかを確認することで、それが変更可能であることを確認します。

   1. 変更可能な場合は、パラメータを選択し、コンソールページの右上にある [**編集**] を選択します。

   1. [**`<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 クラスターパラメータリファレンス](cluster_parameter_groups-list_of_parameters.md) を参照してください。各パラメータの入力には以下を含める必要があります。
  + **ParameterName** - 変更するパラメータの名前です。
  + **ParameterValue** - このパラメータの新しい値です。
  + **ApplyMethod** - このパラメータの変更を適用する方法です。有効な値は、`immediate` および `pending-reboot` です。
**注記**  
`ApplyType` が `static` であるパラメータでは、`ApplyMethod` が `pending-reboot` である必要があります。

**Example - パラメータの値を変更する**  
この例では、`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"
              }
          ]
   }
   ```

1. `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"
      }
   ```

1. 少なくとも 5 分お待ち下さい。

1. `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"
              }
          ]
   }
   ```

------

# カスタムクラスターパラメータグループを使用するために Amazon DocumentDB クラスターを変更する
<a name="cluster_parameter_groups-modify_clusters"></a>

Amazon DocumentDB クラスターを作成すると、そのクラスター用に `default.docdb4.0` パラメータグループが自動的に作成されます。`default` クラスターパラメータグループは変更できません。代わりに、Amazon DocumentDB クラスターを変更して、新しいカスタマイズされたパラメータグループをそれに関連付けることができます。

このセクションでは、 AWS マネジメントコンソール と AWS Command Line Interface () を使用して、既存の Amazon DocumentDB クラスターを変更してカスタムクラスターパラメータグループを使用する方法について説明しますAWS CLI。

------
#### [ Using the AWS マネジメントコンソール ]

**Amazon DocumentDB クラスターを変更して、新しいデフォルトでないクラスターパラメータグループを使用するには**

1. 開始する前に、Amazon DocumentDB クラスターとクラスターパラメータグループが作成されていることを確認してください。詳細については、「[Amazon DocumentDB クラスターの作成](db-cluster-create.md)」および「[Amazon DocumentDB クラスターパラメータグループを作成する](cluster_parameter_groups-create.md)」を参照してください。

1. クラスターパラメータグループを作成した後、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) でAmazon DocumentDB コンソールを開きます。ナビゲーションペインで、[**クラスター**] を選択し、新しいパラメータグループをクラスターに追加します。

1. パラメータグループを関連付けるクラスターを選択します。[**アクション**] を選択し、[**変更**] を選択してクラスターを変更します。

1. [**クラスターオプション**] で、クラスターを関連付ける新しいパラメータグループを選択します。

1. [**続行**] を選択して、変更の概要を表示します。

1. 変更を確認したら、直ちに、あるいは、[**変更のスケジューリング**] の下にある次のメンテナンスウィンドウ中に適用することができます。

1. [**クラスターの変更**] を選択して、新しいパラメータグループでクラスターを更新します。

------
#### [ Using the AWS CLI ]

開始する前に、Amazon DocumentDB クラスターと、クラスターパラメータグループが作成されていることを確認してください。オペレーションを使用して AWS CLI `create-db-cluster` [ Amazon DocumentDB クラスターを作成できます](https://docs.aws.amazon.com//documentdb/latest/developerguide/db-cluster-create.html)。`create-db-cluster-parameter-group` オペレーションを使用して AWS CLI [クラスターパラメータグループを作成できます](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-create.html)。

新しいクラスターパラメータグループをクラスターに追加するには、以下のパラメータを指定して AWS CLI `modify-db-cluster`オペレーションを使用します。
+ **--db-cluster-identifier** - クラスターの名前（例えば、`sample-cluster`）です。
+ **--db-cluster-parameter-group-name** - クラスターを関連付けるパラメータグループの名前（例えば、`sample-parameter-group`）です。

**Example**  

```
aws docdb modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --db-cluster-parameter-group-name sample-parameter-group
```
このオペレーションによる出力は、次のようになります (JSON 形式)。  

```
"DBCluster": {
    "AvailabilityZones": [
            "us-west-2c",
            "us-west-2b",
            "us-west-2a"
    ],
    "BackupRetentionPeriod": 1,
    "DBClusterIdentifier": "sample-cluster",
    "DBClusterParameterGroup": "sample-parameter-group",
    "DBSubnetGroup": "default",
   ...
}
```

------

# Amazon DocumentDB クラスターパラメータグループをコピーする
<a name="cluster_parameter_groups-copy"></a>

Amazon DocumentDB のクラスターパラメータグループのコピーは、 AWS マネジメントコンソール または AWS Command Line Interface () を使用して作成できますAWS CLI。

------
#### [ Using the AWS マネジメントコンソール ]

以下の手順では、既存のクラスターパラメータグループのコピーを作成して、新しいクラスターパラメータグループを作成する手順について説明します。

**クラスターパラメータグループをコピーするには**

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. ナビゲーションペインで、**[パラメータグループ]** を選択します。

1. [**クラスターパラメータグループ**] ペインで、コピーするクラスターパラメータグループの名前を選択します。

1. [**アクション**] を選択し、[**コピー**] を選択して、そのパラメータグループをコピーします。

1. [**コピーのオプション**] で、新しいクラスターパラメータグループの名前と説明を入力します。次に、[**コピー**] を選択して変更を保存します。

------
#### [ Using the AWS CLI ]

クラスターパラメータグループのコピーを作成するには、以下のパラメータを指定して `copy-db-cluster-parameter-group` オペレーションを使用します。
+ **--source-db-cluster-parameter-group-identifier** — 必須。コピーを作成するクラスターパラメータグループの名前または Amazon リソースネーム (ARN)。

  ソースクラスターパラメータグループとターゲットクラスターパラメータグループが同じである場合 AWS リージョン、識別子は名前または ARN のいずれかになります。

  ソースクラスターパラメータグループとターゲットクラスターパラメータグループが異なる場合 AWS リージョン、識別子は ARN である必要があります。
+ **--target-db-cluster-parameter-group-identifier** — 必須。クラスターパラメータグループコピーの名前または ARN。

  制約:
  + null、空、または空白にすることはできません。
  + 1 ～ 255 の英字、数字、またはハイフンを含む必要があります。
  + 1 字目は英字である必要があります。
  + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。
+ **--target-db-cluster-parameter-group-description** — 必須。クラスターパラメータグループのコピーについてユーザーが入力する説明。

**Example**  
次のコードは、`sample-parameter-group` のコピーを作成し、コピーに `sample-parameter-group-copy` という名前を付けます。  
Linux、macOS、Unix の場合:  

```
aws docdb copy-db-cluster-parameter-group \
    --source-db-cluster-parameter-group-identifier sample-parameter-group \
    --target-db-cluster-parameter-group-identifier sample-parameter-group-copy \
    --target-db-cluster-parameter-group-description "Copy of sample-parameter-group"
```
Windows の場合:  

```
aws docdb copy-db-cluster-parameter-group ^
    --source-db-cluster-parameter-group-identifier sample-parameter-group ^
    --target-db-cluster-parameter-group-identifier sample-parameter-group-copy ^
    --target-db-cluster-parameter-group-description "Copy of sample-parameter-group"
```
このオペレーションによる出力は、次のようになります (JSON 形式)。  

```
{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group-copy",
        "DBClusterParameterGroupName": "sample-parameter-group-copy",
        "DBParameterGroupFamily": "docdb4.0",
        "Description": "Copy of sample-parameter-group"
    }
}
```

------

# Amazon DocumentDB クラスターパラメータグループをリセットする
<a name="cluster_parameter_groups-reset"></a>

Amazon DocumentDB クラスターパラメータグループのパラメータ値の一部またはすべてをデフォルト値にリセットするには、 AWS マネジメントコンソール または AWS Command Line Interface (AWS CLI) を使用してクラスターパラメータグループをリセットします。

------
#### [ Using the AWS マネジメントコンソール ]

以下のステップに従って、クラスターパラメータグループのパラメータ値の一部または全部をデフォルト値にリセットします。

**クラスターパラメータグループのパラメータ値をリセットするには**

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. コンソールの左側のナビゲーションペインで、[**パラメータグループ**] を選択します。

1. [**クラスターパラメータグループ**] ペインで、リセットするクラスターパラメータグループの名前を選択します。

1. [**アクション**] を選択し、[**リセット**] を選択して、そのパラメータグループをリセットします。

1. 結果の [**クラスターパラメータグループのリセットの確認**] ページで、そのパラメータグループのすべてのクラスターパラメータをデフォルトにリセットすることを確認します。次に、[**リセット**] を選択してパラメータグループをリセットします。[**キャンセル**] を選択して変更を破棄することもできます。

------
#### [ Using the AWS CLI ]

クラスターパラメータグループのパラメータ値の一部またはすべてをデフォルト値にリセットするには、次のパラメータを指定して `reset-db-cluster-parameter-group` オペレーションを使用します。
+ **--db-cluster-parameter-group-name** — 必須。リセットするクラスターパラメータグループの名前。
+ **--parameters** - オプション。デフォルト値にリセットするクラスターパラメータグループの `ParameterName` と `ApplyMethod` のリスト。次のインスタンスの再起動または `reboot-db-instance` リクエストで有効にするには、静的パラメータを `pending-reboot` に設定する必要があります。更新された静的パラメータを適用するクラスター内のすべてのインスタンスに対して、`reboot-db-instance` を呼び出す必要があります。

  このパラメータおよび `--reset-all-parameters` は相互に排他的です。いずれかを使用できますが、両方を使用することはできません。
+ **--reset-all-parameters** または **--no-reset-all-parameters** - オプション。すべてのパラメータ (`--reset-all-parameters`) または一部のパラメータのみ (`--no-reset-all-parameters`) をデフォルト値にリセットするかどうかを指定します。`--reset-all-parameters` パラメータおよび `--parameters` は相互に排他的です。いずれかを使用できますが、両方を使用することはできません。

  グループ全体をリセットすると、動的パラメータはただちに更新されます。次のインスタンスの再起動または `reboot-db-instance` リクエストで有効にするには、静的パラメータを `pending-reboot` に設定します。更新された静的パラメータを適用するクラスター内のすべてのインスタンスに対して、`reboot-db-instance` を呼び出す必要があります。

**Example**  
**例 1: すべてのパラメータをデフォルト値にリセットする**  
次のコードでは、クラスターパラメータグループ `sample-parameter-group` のすべてのパラメータをデフォルト値にリセットします。
Linux、macOS、Unix の場合:  

```
aws docdb reset-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group \
       --reset-all-parameters
```
Windows の場合:  

```
aws docdb reset-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group ^
       --reset-all-parameters
```
**例 2: 指定されたパラメータをデフォルト値にリセットする**  
次のコードでは、クラスターパラメータグループ `sample-parameter-group` の `tls` パラメータをデフォルト値にリセットします。
Linux、macOS、Unix の場合:  

```
aws docdb reset-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group \
       --no-reset-all-parameters \
       --parameters ParameterName=tls,ApplyMethod=pending-reboot
```
Windows の場合:  

```
aws docdb reset-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group ^
       --no-reset-all-parameters ^
       --parameters ParameterName=tls,ApplyMethod=pending-reboot
```
このオペレーションによる出力は、次のようになります (JSON 形式)。  

```
{
       "DBClusterParameterGroupName": "sample-parameter-group"
   }
```
**クラスターインスタンスの再起動**  
静的パラメータの値が変更される前に、クラスターインスタンスを再起動する必要があります。更新された静的パラメータを適用するクラスター内の各インスタンスを再起動します。
Linux、macOS、Unix の場合:  

```
aws docdb reboot-db-instance \
       --db-instance-identifier sample-cluster-instance
```
Windows の場合:  

```
aws docdb reboot-db-instance ^
       --db-instance-identifier sample-cluster-instance
```

------

# Amazon DocumentDB クラスターパラメータグループを削除する
<a name="cluster_parameter_groups-delete"></a>

 AWS マネジメントコンソール または AWS Command Line Interface () を使用して、カスタム Amazon DocumentDB クラスターパラメータグループを削除できますAWS CLI。`default.docdb4.0` クラスターパラメータグループは削除できません。

------
#### [ Using the AWS マネジメントコンソール ]

**クラスターパラメータグループを削除するには**

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. ナビゲーションペインで、**[パラメータグループ]** を選択します。
**ヒント**  
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。

1. [**パラメータグループ**] ペインで、削除するクラスターパラメータグループの左にあるラジオボタンを選択します。

1. **[アクション]** を選択し、**[削除]** を選択します。

1. [**削除**] 確認ペインで、[**削除**] を選択してクラスターパラメータグループを削除します。クラスターパラメータグループを維持するには、[**キャンセル**] を選択します。

------
#### [ Using the AWS CLI ]

クラスターパラメータグループを削除するには、以下のパラメータを指定して `delete-db-cluster-parameter-group` オペレーションを使用します。
+ **--db-cluster-parameter-group-name** — 必須。削除するクラスターパラメータグループの名前。これは既存のクラスターパラメータグループである必要があります。*`default.docdb4.0` クラスターパラメータグループは削除できません。*

**Example - クラスターパラメータグループの削除**  
以下の例では、クラスターパラメータグループを削除するための 3 つのステップについて説明します。  

1. 削除するクラスターパラメータグループの名前を見つける。

1. 指定されたクラスターパラメータグループを削除する。

1. クラスターパラメータグループが削除されたことを確認する。
**1. 削除するクラスターパラメータグループの名前を見つけます。**  
次のコードは、すべてのクラスターパラメータグループの名前を表示します。
Linux、macOS、Unix の場合:  

```
aws docdb describe-db-cluster-parameter-groups \
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
Windows の場合:  

```
aws docdb describe-db-cluster-parameter-groups ^
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
前のオペレーションの出力は、次のようなクラスターパラメータグループの名前のリストになります (JSON 形式)。  

```
[
       [
           "default.docdb4.0"
       ],
       [
           "sample-parameter-group"
       ],
       [
           "sample-parameter-group-copy"
       ]
   ]
```
**2. 特定のクラスターパラメータグループを削除します。**  
以下のコードは、クラスターパラメータグループ `sample-parameter-group-copy` を削除します。
Linux、macOS、Unix の場合:  

```
aws docdb delete-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group-copy
```
Windows の場合:  

```
aws docdb delete-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group-copy
```
このオペレーションからの出力はありません。  
**3. 指定されたクラスターパラメータグループが削除されたことを確認します。**  
次のコードは、残りのすべてのクラスターパラメータグループの名前を表示します。
Linux、macOS、Unix の場合:  

```
aws docdb describe-db-cluster-parameter-groups \
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
Windows の場合:  

```
aws docdb describe-db-cluster-parameter-groups ^
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
前のオペレーションの出力は、次のようなクラスターパラメータグループのリストになります (JSON 形式)。先ほど削除したクラスターパラメータグループはリストに含まれません。  
このオペレーションによる出力は、次のようになります (JSON 形式)。  

```
[
       [
           "default.docdb4.0"
       ],
       [
           "sample-parameter-group"
       ]
   ]
```

------

# Amazon DocumentDB クラスターパラメータリファレンス
<a name="cluster_parameter_groups-list_of_parameters"></a>

動的なパラメータを変更し、クラスターパラメータグループを保存すると、[*すぐに適用*] の設定にかかわらず、変更は直ちに適用されます。静的パラメータを変更し、クラスターパラメータグループを保存すると、パラメーターの変更はインスタンスを手動で再起動した後に有効になります。Amazon DocumentDB コンソールを使用するか、`reboot-db-instance` を明示的に呼び出して、インスタンスを再起動できます。

次の表は、Amazon DocumentDB クラスターのすべてのインスタンスに適用されるパラメータを示しています。


**Amazon DocumentDB クラスターレベルのパラメータ**  

| パラメータ | デフォルト値 | 有効値 | 変更可能 | 適用タイプ | データタイプ | 説明 | 
| --- | --- | --- | --- | --- | --- | --- | 
| audit\$1logs | 無効 | 有効、無効、ddl、dml\$1read、dml\$1write、すべて、なし | Yes | 動的 | String | Amazon CloudWatch 監査ログを有効にするかどうかを定義します。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| change\$1stream\$1log\$1retention\$1duration | 10800 | 3600-604800 | はい | 動的 | 整数 | 変更ストリームログが保持され、消費できる期間 (秒単位) を定義します。 | 
| default\$1collection\$1compression | 無効 | 有効、無効 (Amazon DocumentDB 5.0) / zstd、lz4、なし (Amazon DocumentDB8.0) | はい | 動的 | String | クラスター内の新しいコレクションのデフォルトの圧縮設定を定義します。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| profiler | 無効 | 有効、無効 | はい | 動的 | String | 低速のオペレーションについてプロファイリングを有効にします。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| profiler\$1sampling\$1rate | 1.0 | 0.0-1.0 | はい | 動的 | 浮動小数点数 | ログに記録されるオペレーションのサンプリングレートを定義します。 | 
| profiler\$1threshold\$1ms | 100 | 50-2147483646 | はい | 動的 | 整数 | profiler のしきい値を定義します。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| planner\$1version | 3.0 | 1.0、2.0、3.0 | はい | 動的 | 浮動小数点数 | クエリに使用するクエリプランナーのバージョンを定義します。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| tls | 有効 | 有効、無効、fips-140-3、tls1.2\$1、tls1.3\$1 | はい | 静的 | String | Transport Layer Security (TLS) 接続が必要かどうかを定義します。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| ttl\$1monitor | 有効 | 有効、無効 | はい | 動的 | String | クラスターに対して有効期限 (TTL) モニタリングを有効にするかどうかを定義します。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 

# Amazon DocumentDB クラスターパラメータを変更する
<a name="cluster_parameter_groups-parameters"></a>

Amazon DocumentDB では、*クラスターパラメータグループ* は、クラスターで作成するすべてのインスタンスに適用される *パラメータ* で構成されています。カスタムクラスターパラメータグループでは、パラメータ値をいつでも変更したり、作成したパラメータグループのすべてのパラメータ値をデフォルトにリセットできます。このセクションでは、Amazon DocumentDB クラスターパラメータグループを構成するパラメータとその値を表示する方法、およびこれらの値を変更または更新する方法について説明します。

パラメータは*動的*でも*静的*でもかまいません。動的なパラメータを変更し、クラスターパラメータグループを保存すると、`Apply Immediately` の設定にかかわらず、変更は直ちに適用されます。静的パラメータを変更し、クラスターパラメータグループを保存すると、変更はインスタンスを手動で再起動した後にのみ有効になります。

## Amazon DocumentDB クラスターパラメータグループのパラメータを表示する
<a name="cluster_parameter_groups-describe_details_parameters"></a>

Amazon DocumentDB クラスターのパラメータとその値は、 AWS マネジメントコンソール または を使用して確認できます AWS CLI。

------
#### [ Using the AWS マネジメントコンソール ]

**クラスターパラメータグループの詳細情報を表示するには**

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. ナビゲーションペインで、**[パラメータグループ]** を選択します。
**ヒント**  
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。

1. [**パラメータグループ**] ペインで、詳細情報を表示するクラスターパラメータグループの名前を選択します。

1. 結果ページには、各パラメータのパラメータ名、現在の値、許可された値、パラメータが変更可能かどうか、適用タイプ、データ型および説明の値が表示されます。  
![\[スクリーンショット: パラメータの名前と値。\]](http://docs.aws.amazon.com/ja_jp/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 クラスターパラメータグループのパラメータを変更する
<a name="cluster_parameter_groups-modify_parameters"></a>

パラメータグループのパラメータは、 AWS マネジメントコンソール または を使用して変更できます AWS CLI。

------
#### [ Using the AWS マネジメントコンソール ]

**クラスターパラメータグループのパラメータを更新するには**

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. ナビゲーションペインで、**[パラメータグループ]** を選択します。
**ヒント**  
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/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` です。
**注記**  
`ApplyType` が `static` であるパラメータでは、`ApplyMethod` が `pending-reboot` である必要があります。

**クラスターパラメータグループのパラメータの値を変更するには (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`** になるようにします。`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"
   }
   ```

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

------