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

******************************
describe_db_cluster_parameters
******************************



.. py:method:: DocDB.Client.describe_db_cluster_parameters(**kwargs)

  

  Returns the detailed parameter list for a particular cluster parameter group.

  

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


  **Request Syntax**
  ::

    response = client.describe_db_cluster_parameters(
        DBClusterParameterGroupName='string',
        Source='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='string'
    )
    
  :type DBClusterParameterGroupName: string
  :param DBClusterParameterGroupName: **[REQUIRED]** 

    The name of a specific cluster parameter group to return parameter details for.

     

    Constraints:

     

    
    * If provided, must match the name of an existing ``DBClusterParameterGroup``.
    

    

  
  :type Source: string
  :param Source: 

    A value that indicates to return only parameters for a specific source. Parameter sources can be ``engine``, ``service``, or ``customer``.

    

  
  :type Filters: list
  :param Filters: 

    This parameter is not currently supported.

    

  
    - *(dict) --* 

      A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

       

      Wildcards are not supported in filters.

      

    
      - **Name** *(string) --* **[REQUIRED]** 

        The name of the filter. Filter names are case sensitive.

        

      
      - **Values** *(list) --* **[REQUIRED]** 

        One or more filter values. Filter values are case sensitive.

        

      
        - *(string) --* 

        
    
    

  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

     

    Default: 100

     

    Constraints: Minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Parameters': [
              {
                  'ParameterName': 'string',
                  'ParameterValue': 'string',
                  'Description': 'string',
                  'Source': 'string',
                  'ApplyType': 'string',
                  'DataType': 'string',
                  'AllowedValues': 'string',
                  'IsModifiable': True|False,
                  'MinimumEngineVersion': 'string',
                  'ApplyMethod': 'immediate'|'pending-reboot'
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of  DBClusterParameterGroup.

      
      

      - **Parameters** *(list) --* 

        Provides a list of parameters for the cluster parameter group.

        
        

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

            
      
    
      

      - **Marker** *(string) --* 

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

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

  