:doc:`DocDB <../../docdb>` / Client / reset_db_cluster_parameter_group

********************************
reset_db_cluster_parameter_group
********************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResetDBClusterParameterGroup>`_  


  **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'
            },
        ]
    )
    
  :type DBClusterParameterGroupName: string
  :param DBClusterParameterGroupName: **[REQUIRED]** 

    The name of the cluster parameter group to reset.

    

  
  :type ResetAllParameters: boolean
  :param ResetAllParameters: 

    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.

    

  
  :type Parameters: list
  :param Parameters: 

    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. Must be one or more of the cluster parameter's ``AllowedValues`` in CSV format:

         

        Valid values are:

         

        
        * ``enabled``: The cluster accepts secure connections using TLS version 1.0 through 1.3.
         
        * ``disabled``: The cluster does not accept secure connections using TLS.
         
        * ``fips-140-3``: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.
         
        * ``tls1.2+``: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).
         
        * ``tls1.3+``: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).
        

        

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

        

      
    

  
  :rtype: 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**
  
  *   :py:class:`DocDB.Client.exceptions.InvalidDBParameterGroupStateFault`

  
  *   :py:class:`DocDB.Client.exceptions.DBParameterGroupNotFoundFault`

  