ResetDBClusterParameterGroupCommand

Suggest an Edit

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

Example Syntax

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

import { DocDBClient, ResetDBClusterParameterGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, ResetDBClusterParameterGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // ResetDBClusterParameterGroupMessage
  DBClusterParameterGroupName: "STRING_VALUE", // required
  ResetAllParameters: true || false,
  Parameters: [ // ParametersList
    { // 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",
    },
  ],
};
const command = new ResetDBClusterParameterGroupCommand(input);
const response = await client.send(command);
// { // DBClusterParameterGroupNameMessage
//   DBClusterParameterGroupName: "STRING_VALUE",
// };

ResetDBClusterParameterGroupCommand Input

See ResetDBClusterParameterGroupCommandInput for more details

Parameter
Type
Description
DBClusterParameterGroupName
Required
string | undefined

The name of the cluster parameter group to reset.

Parameters
Parameter[] | undefined

A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

ResetAllParameters
boolean | undefined

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

ResetDBClusterParameterGroupCommand Output

See ResetDBClusterParameterGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DBClusterParameterGroupName
string | undefined

The name of a cluster parameter group.

Constraints:

  • Must be from 1 to 255 letters or numbers.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

Throws

Name
Fault
Details
DBParameterGroupNotFoundFault
client

DBParameterGroupName doesn't refer to an existing parameter group.

InvalidDBParameterGroupStateFault
client

The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.