describe_engine_default_cluster_parameters

DocDB.Client.describe_engine_default_cluster_parameters(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_engine_default_cluster_parameters(
    DBParameterGroupFamily='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters

• DBParameterGroupFamily (string) --

  [REQUIRED]

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

• Filters (list) --

  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) --
• MaxRecords (integer) --

  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.

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

Return type

dict

Returns

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

Response Structure

• (dict) --

  • EngineDefaults (dict) --

    Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

    • DBParameterGroupFamily (string) --

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

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

    • Parameters (list) --

      The parameters of a particular cluster parameter group family.

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