:doc:`RDS <../../rds>` / Client / modify_db_cluster_parameter_group

*********************************
modify_db_cluster_parameter_group
*********************************



.. py:method:: RDS.Client.modify_db_cluster_parameter_group(**kwargs)

  

  Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ``ParameterName``, ``ParameterValue``, and ``ApplyMethod``. A maximum of 20 parameters can be modified in a single request.

   

  .. warning::

     

    There are two types of parameters - dynamic parameters and static parameters. Changes to dynamic parameters are applied to the DB cluster immediately without a reboot. Changes to static parameters are applied only after the DB cluster is rebooted, which can be done using ``RebootDBCluster`` operation. You can use the *Parameter Groups* option of the `Amazon RDS console <https://console.aws.amazon.com/rds/>`__ or the ``DescribeDBClusterParameters`` operation to verify that your DB cluster parameter group has been created or modified.

     

   

  For more information on Amazon Aurora DB clusters, see `What is Amazon Aurora? <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html>`__ in the *Amazon Aurora User Guide*.

   

  For more information on Multi-AZ DB clusters, see `Multi-AZ DB cluster deployments <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html>`__ in the *Amazon RDS User Guide.*

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterParameterGroup>`_  


  **Request Syntax**
  ::

    response = client.modify_db_cluster_parameter_group(
        DBClusterParameterGroupName='string',
        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',
                ]
            },
        ]
    )
    
  :type DBClusterParameterGroupName: string
  :param DBClusterParameterGroupName: **[REQUIRED]** 

    The name of the DB cluster parameter group to modify.

    

  
  :type Parameters: list
  :param Parameters: **[REQUIRED]** 

    A list of parameters in the DB cluster parameter group to modify.

     

    Valid Values (for the application method): ``immediate | pending-reboot``

     

    .. note::

      

      You can use the ``immediate`` value with dynamic parameters only. You can use the ``pending-reboot`` value for both dynamic and static parameters.

       

      When the application method is ``immediate``, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is ``pending-reboot``, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.

      

    

  
    - *(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) --* 

        The name of the parameter.

        

      
      - **ParameterValue** *(string) --* 

        The value of the parameter.

        

      
      - **Description** *(string) --* 

        Provides a description of the parameter.

        

      
      - **Source** *(string) --* 

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

        
    
    

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

  
  *   :py:class:`RDS.Client.exceptions.InvalidDBParameterGroupStateFault`

  

  **Examples**

  This example immediately changes the specified setting for the specified DB cluster parameter group.
  ::

    response = client.modify_db_cluster_parameter_group(
        DBClusterParameterGroupName='mydbclusterparametergroup',
        Parameters=[
            {
                'ApplyMethod': 'immediate',
                'ParameterName': 'time_zone',
                'ParameterValue': 'America/Phoenix',
            },
        ],
    )
    
    print(response)

  
  Expected Output:
  ::

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

  