マルチ AZ DB クラスターの DB クラスターパラメータグループを使用する - Amazon Relational Database Service
DB クラスターのパラメータグループの作成DB クラスターパラメータグループのパラメータの変更DB クラスターパラメータグループのパラメータのリセットDB クラスターのパラメータグループのコピーDB クラスターのパラメータグループのリスト化DB クラスターパラメータグループのパラメータ値を表示するDB クラスターパラメータグループの削除

マルチ AZ DB クラスターの DB クラスターパラメータグループを使用する

マルチ AZ DB クラスターでは、DB クラスターパラメータグループが使用されます。次のセクションでは、DB クラスターパラメータグループの設定と管理について説明します。

DB クラスターのパラメータグループの作成

新しい DB クラスターパラメータグループは、AWS Management Console、AWS CLI、または RDS API を使って作成できます。

DB クラスターパラメータグループの作成後、その DB クラスターパラメータグループを使用する最初の DB クラスターが作成されるまで、5 分以上かかります。これにより、Amazon RDS は新しい DB クラスターによって使用される前に、パラメータグループを完全に作成することができます。DB クラスターパラメータグループが作成されたことを確認するには、Amazon RDS コンソールの [Parameter groups] (パラメータグループ) ページまたは describe-db-cluster-parameters コマンドを使用できます。

DB クラスターパラメータグループ名には、次の制限事項が適用されます。

  • 名前は、1～255 の英字、数字、ハイフンである必要があります。

    デフォルトのパラメータグループ名には、default.aurora-mysql5.7 のようなピリオドを含めることができます。ただし、カスタムパラメータグループ名にはピリオドを含めることはできません。

  • 1 字目は文字である必要があります。

  • 名前の最後にハイフンを使用したり、ハイフンを 2 つ続けて使用したりすることはできません。

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

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

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

  3. [Create parameter group] (パラメータグループの作成) を選択します。

    [パラメータグループの作成] ウィンドウが表示されます。

  4. [パラメータグループファミリー] リストで、DB パラメータグループファミリーを選択します。

  5. [タイプ] リストで、[DB クラスターパラメータグループ] を選択します。

  6. [グループ名] ボックスに、新しい DB クラスターパラメータグループの名前を入力します。

  7. [説明] ボックスに、新しい DB クラスターパラメータグループの説明を入力します。

  8. [Create] を選択します。

DB クラスターのパラメータグループを作成するには、AWS CLI​ の ​create-db-cluster-parameter-group​ コマンドを使用します。

次の例では、RDS for MySQL バージョン 8.0 用に、mydbclusterparametergroup という名前で、「My new cluster parameter group」(新しいクラスターパラメータグループ) という説明の DB クラスターパラメータグループを作成しています。

以下の必須パラメータを含めます。

  • --db-cluster-parameter-group-name

  • --db-parameter-group-family

  • --description

使用可能なすべてのパラメータグループファミリーを一覧表示するには、次のコマンドを使用します。

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
注記

出力は重複が含まれます。

例

Linux、macOS、Unix の場合:

aws rds create-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclusterparametergroup \
    --db-parameter-group-family mysql8.0 \
    --description "My new cluster parameter group"

Windows の場合:

aws rds create-db-cluster-parameter-group ^
    --db-cluster-parameter-group-name mydbclusterparametergroup ^
    --db-parameter-group-family mysql8.0 ^
    --description "My new cluster parameter group"

このコマンドでは、以下のような出力が生成されます。

{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "mydbclusterparametergroup",
        "DBParameterGroupFamily": "mysql8.0",
        "Description": "My new cluster parameter group",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup2"
    }
}

DB クラスターのパラメータグループを作成するには、​RDS API の ​CreateDBClusterParameterGroup アクションを使用します。

以下の必須パラメータを含めます。

  • DBClusterParameterGroupName

  • DBParameterGroupFamily

  • Description

DB クラスターパラメータグループのパラメータの変更

ユーザーが作成した DB クラスターパラメータグループのパラメータ値は変更できます。デフォルト DB クラスターパラメータグループのパラメータ値は変更できません。ユーザー定義の DB クラスターパラメータグループのパラメータの変更は、その DB クラスターパラメータグループに関連付けられたすべての DB クラスターに適用されます。

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

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

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

  3. リストで、変更するパラメータグループを選択します。

  4. [Parameter group actions (パラメータグループのアクション)] で、[編集] を選択します。

  5. 変更するパラメータの値を変更します。ダイアログボックスの右上にある矢印キーを使用して、パラメータをスクロールできます。

    デフォルトパラメータグループの値を変更することはできません。

  6. [Save changes] (変更の保存) をクリックします。

  7. クラスター内のプライマリ (ライター) DB インスタンスを再起動して、変更を適用します。

  8. 次に、リーダー DB インスタンスを再起動して、変更を適用します。

DB クラスターパラメータグループを変更するには、以下の必須パラメータを指定しながら AWS CLI の modify-db-cluster-parameter-group コマンドを使用します。

  • --db-cluster-parameter-group-name

  • --parameters

以下の例では、mydbclusterparametergroup という名前の DB クラスターパラメータグループの server_audit_logging と server_audit_logs_upload の値を変更しています。

例

Linux、macOS、Unix の場合:

aws rds modify-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclusterparametergroup \
    --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" \
                 "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate"

Windows の場合:

aws rds modify-db-cluster-parameter-group ^
    --db-cluster-parameter-group-name mydbclusterparametergroup ^
    --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" ^
                 "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate"

このコマンドでは、以下のような出力が生成されます。

DBCLUSTERPARAMETERGROUP  mydbclusterparametergroup

DB クラスターのパラメータグループを変更するには、以下の必須パラメータを指定ながら RDS API の ModifyDBClusterParameterGroup コマンドを使用します。

  • DBClusterParameterGroupName

  • Parameters

DB クラスターパラメータグループのパラメータのリセット

顧客が作成した DB クラスターパラメータグループの、デフォルト値のパラメータはリセットできます。ユーザー定義の DB クラスターパラメータグループのパラメータの変更は、その DB クラスターパラメータグループに関連付けられたすべての DB クラスターに適用されます。

注記

デフォルトの DB クラスターパラメータグループでは、パラメータは常にデフォルト値に設定されます。

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

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

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

  3. リストからパラメータグループを選択します。

  4. [Parameter group actions (パラメータグループのアクション)] で、[編集] を選択します。

  5. デフォルト値にリセットするパラメータを選択します。ダイアログボックスの右上にある矢印キーを使用して、パラメータをスクロールできます。

    デフォルトのパラメータグループの値をリセットすることはできません。

  6. リセットを選択し、パラメータをリセットを選択して確定します。

  7. DB クラスター内のプライマリ DB インスタンスを再起動して、DB クラスター内のすべての DB インスタンスに変更を適用します。

DB クラスターのパラメータグループにおいて、パラメータをデフォルト値にリセットするには、以下の --db-cluster-parameter-group-name オプション (必須) を指定しながら AWS CLI の reset-db-cluster-parameter-group コマンドを使用します。

DB クラスターパラメータグループのパラメータをすべてリセットするには、--reset-all-parameters オプションを指定します。特定のパラメータをリセットするには、--parametersオプションを指定します。

次の例では、mydbparametergroupという名前の DB パラメータグループ内のすべてのパラメータをデフォルト値にリセットします。

例

Linux、macOS、Unix の場合:

aws rds reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbparametergroup \
    --reset-all-parameters

Windows の場合:

aws rds reset-db-cluster-parameter-group ^
    --db-cluster-parameter-group-name mydbparametergroup ^
    --reset-all-parameters

以下の例では、mydbclusterparametergroup という名前の DB クラスターパラメータグループにある server_audit_logging と server_audit_logs_upload をデフォルト値にリセットしています。

例

Linux、macOS、Unix の場合:

aws rds reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclusterparametergroup \
    --parameters "ParameterName=server_audit_logging,ApplyMethod=immediate" \
                 "ParameterName=server_audit_logs_upload,ApplyMethod=immediate"

Windows の場合:

aws rds reset-db-cluster-parameter-group ^
    --db-cluster-parameter-group-name mydbclusterparametergroup ^
    --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" ^
                 "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate"

このコマンドでは、以下のような出力が生成されます。

DBClusterParameterGroupName  mydbclusterparametergroup

DB クラスターパラメータグループのパラメータをデフォルト値にリセットするには、以下の必須パラメータを指定して、RDS API ResetDBClusterParameterGroupコマンドを使用します。DBClusterParameterGroupName

DB クラスターパラメータグループのパラメータをすべてリセットするには、ResetAllParameters パラメータを true に設定します。特定のパラメータをリセットするには、Parametersパラメータを指定します。

DB クラスターのパラメータグループのコピー

作成したカスタム DB クラスターパラメータグループをコピーできます。パラメータグループのコピーは、作成済みの DB クラスターパラメータグループがあり、そのグループの多くのカスタムパラメータと値を新しい DB クラスターパラメータグループに含める必要がある場合に便利な方法です。DB クラスターパラメータグループをコピーするには、AWS CLI copy-db-cluster-parameter-group コマンド、または RDS API CopyDBClusterParameterGroup オペレーションを使用できます。

DB クラスターパラメータグループをコピーした後で、この DB クラスターパラメータグループを使用する DB クラスターを作成するまで、5 分以上かかります。これにより、Amazon RDS は新しい DB クラスターによって使用される前に、パラメータグループを完全にコピーすることができます。DB クラスターパラメータグループが作成されたことを確認するには、Amazon RDS コンソールの [Parameter groups] (パラメータグループ) ページまたは describe-db-cluster-parameters コマンドを使用できます。

注記

デフォルトのパラメータグループをコピーすることはできません。ただし、デフォルトのパラメータグループに基づく新しいパラメータグループを作成できます。

DB クラスターパラメータグループを別の AWS アカウント または AWS リージョン にコピーすることはできません。

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

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

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

  3. リストで、コピーするカスタムパラメータグループを選択します。

  4. [Parameter group actions (パラメータグループのアクション)] で、[コピー] を選択します。

  5. [新規の DB パラメータグループの識別子] に、新しいパラメータグループの名前を入力します。

  6. [説明] に、新しいパラメータグループの説明を入力します。

  7. [Copy (コピー)] を選択します。

DB クラスターのパラメータグループをコピーするには、以下の必須パラメータを指定しながら AWS CLI の copy-db-cluster-parameter-group コマンドを使用します。

  • --source-db-cluster-parameter-group-identifier

  • --target-db-cluster-parameter-group-identifier

  • --target-db-cluster-parameter-group-description

次の例は、DB クラスターパラメータグループ mygroup2 のコピーである mygroup1 という名前の新しい DB クラスターパラメータグループを作成します。

例

Linux、macOS、Unix の場合:

aws rds copy-db-cluster-parameter-group \
    --source-db-cluster-parameter-group-identifier mygroup1 \
    --target-db-cluster-parameter-group-identifier mygroup2 \
    --target-db-cluster-parameter-group-description "DB parameter group 2"

Windows の場合:

aws rds copy-db-cluster-parameter-group ^
    --source-db-cluster-parameter-group-identifier mygroup1 ^
    --target-db-cluster-parameter-group-identifier mygroup2 ^
    --target-db-cluster-parameter-group-description "DB parameter group 2"

DB クラスターパラメータグループをコピーするには、以下の必須パラメータを指定して、RDS API の CopyDBClusterParameterGroup オペレーションを使用します。

  • SourceDBClusterParameterGroupIdentifier

  • TargetDBClusterParameterGroupIdentifier

  • TargetDBClusterParameterGroupDescription

DB クラスターのパラメータグループのリスト化

AWS アカウント用に作成した DB クラスターパラメータグループを一覧表示できます。

注記

デフォルトのパラメータグループは、特定の DB エンジンとバージョンの DB クラスターを作成するときに、デフォルトのパラメータテンプレートから自動的に作成されます。これらのデフォルトのパラメータグループには、優先されるパラメータ設定が含まれています。これを変更することはできません。カスタムパラメータグループを作成する場合、パラメータ設定を変更できます。

AWS アカウントのすべての DB クラスターパラメータグループを一覧表示するには

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

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

    DB クラスターパラメータグループは、[Type] (タイプ) が [DB cluster parameter group] (DB クラスターパラメータグループ) のリストに表示されます。

AWS アカウントにある、すべての DB クラスターのパラメータグループを一覧表示するには、AWS CLI の describe-db-cluster-parameter-groups コマンドを使用します。

例

以下の例では、AWS アカウントに使用できるすべての DB クラスターパラメータグループを一覧表示しています。

aws rds describe-db-cluster-parameter-groups

次の例は、mydbclusterparametergroup パラメータグループを表しています。

Linux、macOS、Unix の場合:

aws rds describe-db-cluster-parameter-groups \
    --db-cluster-parameter-group-name mydbclusterparametergroup

Windows の場合:

aws rds describe-db-cluster-parameter-groups ^
    --db-cluster-parameter-group-name mydbclusterparametergroup

このコマンドでは次のようなレスポンスが返されます。

{
    "DBClusterParameterGroups": [
        {
            "DBClusterParameterGroupName": "mydbclusterparametergroup2",
            "DBParameterGroupFamily": "mysql8.0",
            "Description": "My new cluster parameter group",
            "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup"
        }
    ]
}

AWS アカウントにある、すべての DB クラスターのパラメータグループを一覧表示するには、RDS API の DescribeDBClusterParameterGroups アクションを使用します。

DB クラスターパラメータグループのパラメータ値を表示する

DB クラスターパラメータグループのすべてのパラメータとそれらの値のリストを取得できます。

DB クラスターパラメータグループのパラメータ値を表示するには

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

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

    DB クラスターパラメータグループは、[Type] (タイプ) が [DB cluster parameter group] (DB クラスターパラメータグループ) のリストに表示されます。

  3. パラメータを一覧表示する DB クラスターパラメータグループの名前を選択します。

DB クラスターのパラメータグループについて、そのパラメータ値を表示するには、以下の必須パラメータを指定しながら AWS CLI の describe-db-cluster-parameters コマンドを使用します。

  • --db-cluster-parameter-group-name

例

以下の例では、JSON 形式の mydbclusterparametergroup という名前の DB クラスターパラメータグループのパラメータとその値を一覧表示しています。

このコマンドでは次のようなレスポンスが返されます。

aws rds describe-db-cluster-parameters --db-cluster-parameter-group-name mydbclusterparametergroup
{
    "Parameters": [
        {
            "ParameterName": "activate_all_roles_on_login",
            "ParameterValue": "0",
            "Description": "Automatically set all granted roles as active after the user has authenticated successfully.",
            "Source": "engine-default",
            "ApplyType": "dynamic",
            "DataType": "boolean",
            "AllowedValues": "0,1",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot",
            "SupportedEngineModes": [
                "provisioned"
            ]
        },
        {
            "ParameterName": "allow-suspicious-udfs",
            "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
            "Source": "engine-default",
            "ApplyType": "static",
            "DataType": "boolean",
            "AllowedValues": "0,1",
            "IsModifiable": false,
            "ApplyMethod": "pending-reboot",
            "SupportedEngineModes": [
                "provisioned"
            ]
        },
...

DB クラスターパラメータグループのパラメータ値を表示するには、以下の必須パラメータを指定して、RDS API の DescribeDBClusterParameters コマンドを使用します。

  • DBClusterParameterGroupName

場合によっては、パラメータに指定できる値が表示されないことがあります。これらは常にソースがデータベースエンジンのデフォルトであるパラメータです。

これらのパラメータの値を表示するには、次の SQL ステートメントを実行します。

  • MySQL:

    -- Show the value of a particular parameter
mysql$ SHOW VARIABLES LIKE '%parameter_name%';

-- Show the values of all parameters
mysql$ SHOW VARIABLES;

  • PostgreSQL:

    -- Show the value of a particular parameter
postgresql=> SHOW parameter_name;

-- Show the values of all parameters
postgresql=> SHOW ALL;

DB クラスターパラメータグループの削除

DB クラスターパラメータグループは、AWS Management Console、AWS CLI、または RDS API を使用して削除できます。DB クラスターパラメータグループは、DB クラスターに関連付けられていない場合にのみ削除できます。

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

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

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

    パラメータグループがリストに表示されます。

  3. 削除する DB クラスターパラメータグループの名前を選択します。

  4. [Actions (アクション)] を選択してから [Delete (削除)] を選択します。

  5. パラメータグループ名を確認して、[削除] を選択します。

DB クラスターパラメータグループを削除するには、AWS CLI の delete-db-cluster-parameter-group コマンドを使用して、次の必須パラメータを指定します。

  • --db-parameter-group-name

例

次の例では、mydbparametergroup という名前の DB クラスターパラメータグループを削除します。

aws rds delete-db-cluster-parameter-group --db-parameter-group-name mydbparametergroup

DB クラスターパラメータグループを削除するには、RDS API の DeleteDBClusterParameterGroup コマンドを使用して、次の必須パラメータを指定します。

  • DBParameterGroupName