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.rds.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 | 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 | string | Contains a list of engine default parameters. |
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. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. |
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 DB cluster parameter group family to return engine parameter information for. |
region | string | AWS region (default: us-east-1) |
Filters | array | This parameter isn't currently supported. |
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. |
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. |
SELECT examples
- 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.
SELECT
db_parameter_group_family,
marker,
parameters
FROM aws.rds.engine_default_cluster_parameters
WHERE DBParameterGroupFamily = '{{ DBParameterGroupFamily }}' -- required
AND region = '{{ region }}' -- required
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;