Amazon DocumentDB クラスターパラメータグループの説明

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

Amazon DocumentDB クラスターパラメータグループの詳細について説明します。

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

Using the AWS Management Console

1. にサインインし AWS Management Console、https://console.aws.amazon.com/docdb で Amazon DocumentDB コンソールを開きます。

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

   ヒント

   画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン () を選択します。

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

4. 表示されるページには、パラメータグループのパラメータ、最近のアクティビティ、タグが表示されます。

   • [クラスターパラメータ] には、パラメータの名前、現在の値、許容値、パラメータが変更可能かどうか、適用タイプ、データタイプ、説明が表示されます。個々のパラメータを修正するには、パラメータを選択し、クラスターパラメータ セクションの編集 を選択します。詳細については、「Amazon DocumentDB クラスターパラメータを変更する」を参照してください。

   • [最近のイベント] で、このパラメータグループの最新のイベントを確認できます。このセクションの検索バーを使用して、これらのイベントをフィルタリングできます。詳細については、「Amazon DocumentDB イベントの管理」を参照してください。

   • [タグ] で、このクラスターパラメータグループのタグを表示できます。タグを追加、または削除するには、編集 を タグ のセクションで選択します。詳細については、「Amazon DocumentDB リソースのタグ付け」を参照してください。

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 — 必須。説明するクラスターパラメータグループの名前。

次のコードは、最大 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"
              }
          ]
}

次のコードはARN、、ファミリー、説明、および の名前を一覧表示しますsample-parameter-group。

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

次のコードは、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 クラスターのパラメータグループの確認をする

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

Using the AWS Management Console

1. にサインインし AWS Management Console、https://console.aws.amazon.com/docdb で Amazon DocumentDB コンソールを開きます。

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

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

4. 結果のページには、選択したクラスターの詳細が表示されます。[クラスターの詳細] まで下にスクロールします。そのセクションの下部で、[クラスターパラメータグループ] の下にパラメータグループの名前を見つけます。

   

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