RDS / Client / describe_engine_default_cluster_parameters



Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_engine_default_cluster_parameters(
            'Name': 'string',
            'Values': [
  • DBParameterGroupFamily (string) –


    The name of the DB cluster parameter group family to return engine parameter information for.

  • Filters (list) –

    This parameter isn’t currently supported.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.


      Currently, wildcards are not supported in filters.

      The following actions can be filtered:

      • DescribeDBClusterBacktracks

      • DescribeDBClusterEndpoints

      • DescribeDBClusters

      • DescribeDBInstances

      • DescribeDBRecommendations

      • DescribeDBShardGroups

      • DescribePendingMaintenanceActions

      • 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) –

  • MaxRecords (integer) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Marker (string) – An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:



Response Syntax

    'EngineDefaults': {
        'DBParameterGroupFamily': 'string',
        'Marker': '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': [

Response Structure

  • (dict) –

    • EngineDefaults (dict) –

      Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

      • DBParameterGroupFamily (string) –

        Specifies the name of the DB parameter group family that the engine default parameters apply to.

      • Marker (string) –

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

      • Parameters (list) –

        Contains a list of engine default parameters.

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


This example lists default parameters for the specified DB cluster engine.

response = client.describe_engine_default_cluster_parameters(


Expected Output:

    'EngineDefaults': {
    'ResponseMetadata': {
        '...': '...',