DocDB / Client / reset_db_cluster_parameter_group

reset_db_cluster_parameter_group

DocDB.Client.reset_db_cluster_parameter_group(**kwargs)

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.

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'
        },
    ]
)

Parameters:

• DBClusterParameterGroupName (string) –

  [REQUIRED]

  The name of the cluster parameter group to reset.

• ResetAllParameters (boolean) – 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.

• Parameters (list) –

  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 .

  • (dict) –

    Detailed information about an individual parameter.

    • 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.

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterParameterGroupName': 'string'
}

Response Structure

• (dict) –

  Contains the name of a cluster parameter group.

  • DBClusterParameterGroupName (string) –

    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.

    Note

    This value is stored as a lowercase string.

Exceptions

• DocDB.Client.exceptions.InvalidDBParameterGroupStateFault

• DocDB.Client.exceptions.DBParameterGroupNotFoundFault