Skip to content

RDS  >  Operations  >  reset_db_cluster_parameter_group

reset_db_cluster_parameter_group

Operation

reset_db_cluster_parameter_group async 

reset_db_cluster_parameter_group(input: ResetDBClusterParameterGroupInput, plugins: list[Plugin] | None = None) -> ResetDBClusterParameterGroupOutput

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

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

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.

Parameters:

Name Type Description Default
input ResetDBClusterParameterGroupInput

An instance of ResetDBClusterParameterGroupInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ResetDBClusterParameterGroupOutput

An instance of ResetDBClusterParameterGroupOutput.

Input

ResetDBClusterParameterGroupInput dataclass

Bases: _SerdeShape

Attributes

db_cluster_parameter_group_name class-attribute instance-attribute 
db_cluster_parameter_group_name: str | None = ...

The name of the DB cluster parameter group to reset.

parameters class-attribute instance-attribute 
parameters: list[Parameter] | None = ...

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

reset_all_parameters class-attribute instance-attribute 
reset_all_parameters: bool | None = ...

Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

Output

ResetDBClusterParameterGroupOutput dataclass

Bases: _SerdeShape

Attributes

db_cluster_parameter_group_name class-attribute instance-attribute 
db_cluster_parameter_group_name: str | None = ...

The name of the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Note

This value is stored as a lowercase string.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.