engine_default_cluster_parameters

Creates, updates, deletes, gets or lists an engine_default_cluster_parameters resource.

Overview

Name	engine_default_cluster_parameters
Type	Resource
Id	aws.docdb.engine_default_cluster_parameters

Fields

The following fields are returned by SELECT queries:

describe_engine_default_cluster_parameters

Name	Datatype	Description
db_parameter_group_family	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	string	The parameters of a particular cluster parameter group family.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_engine_default_cluster_parameters	select	DBParameterGroupFamily, region	Filters, MaxRecords, Marker	Returns the default engine and system parameter information for the cluster database engine.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DBParameterGroupFamily	string	The name of the cluster parameter group family to return the engine parameter information for.
region	string	AWS region (default: us-east-1)
Filters	array	This parameter is not currently supported.
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.
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.

SELECT examples

describe_engine_default_cluster_parameters

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

SELECT
db_parameter_group_family,
marker,
parameters
FROM aws.docdb.engine_default_cluster_parameters
WHERE DBParameterGroupFamily = '{{ DBParameterGroupFamily }}' -- required
AND region = '{{ region }}' -- required
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;