Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

ModifyDBClusterParameterGroupCommand

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create operation before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RDSClient, ModifyDBClusterParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, ModifyDBClusterParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // ModifyDBClusterParameterGroupMessage
  DBClusterParameterGroupName: "STRING_VALUE", // required
  Parameters: [ // ParametersList // required
    { // Parameter
      ParameterName: "STRING_VALUE",
      ParameterValue: "STRING_VALUE",
      Description: "STRING_VALUE",
      Source: "STRING_VALUE",
      ApplyType: "STRING_VALUE",
      DataType: "STRING_VALUE",
      AllowedValues: "STRING_VALUE",
      IsModifiable: true || false,
      MinimumEngineVersion: "STRING_VALUE",
      ApplyMethod: "immediate" || "pending-reboot",
      SupportedEngineModes: [ // EngineModeList
        "STRING_VALUE",
      ],
    },
  ],
};
const command = new ModifyDBClusterParameterGroupCommand(input);
const response = await client.send(command);
// { // DBClusterParameterGroupNameMessage
//   DBClusterParameterGroupName: "STRING_VALUE",
// };

Example Usage

Loading code editorLoading code editor