RDS / Client / reset_db_cluster_parameter_group

reset_db_cluster_parameter_group

RDS.Client.reset_db_cluster_parameter_group(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.reset_db_cluster_parameter_group(
    DBClusterParameterGroupName='string',
    ResetAllParameters=True|False,
    Parameters=[
        {
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Description': 'string',
            'Source': 'string',
            'ApplyType': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'IsModifiable': True|False,
            'MinimumEngineVersion': 'string',
            'ApplyMethod': 'immediate'|'pending-reboot',
            'SupportedEngineModes': [
                'string',
            ]
        },
    ]
)

Parameters:

• DBClusterParameterGroupName (string) –

  [REQUIRED]

  The name of the DB cluster parameter group to reset.

• ResetAllParameters (boolean) – A value that indicates 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.

• Parameters (list) –

  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.

  • (dict) –

    This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

    This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

    • ParameterName (string) –

      Specifies the name of the parameter.

    • ParameterValue (string) –

      Specifies the value of the parameter.

    • Description (string) –

      Provides a description of the parameter.

    • Source (string) –

      Indicates the source of the parameter value.

    • ApplyType (string) –

      Specifies the engine specific parameters type.

    • DataType (string) –

      Specifies the valid data type for the parameter.

    • AllowedValues (string) –

      Specifies the valid range of values for the parameter.

    • IsModifiable (boolean) –

      Indicates whether ( true) or not ( false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    • MinimumEngineVersion (string) –

      The earliest engine version to which the parameter can apply.

    • ApplyMethod (string) –

      Indicates when to apply parameter updates.

    • SupportedEngineModes (list) –

      The valid DB engine modes.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterParameterGroupName': 'string'
}

Response Structure

• (dict) –

  • DBClusterParameterGroupName (string) –

    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.

Exceptions

• RDS.Client.exceptions.InvalidDBParameterGroupStateFault

• RDS.Client.exceptions.DBParameterGroupNotFoundFault

Examples

This example resets all parameters for the specified DB cluster parameter group to their default values.

response = client.reset_db_cluster_parameter_group(
    DBClusterParameterGroupName='mydbclusterparametergroup',
    ResetAllParameters=True,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}