default_cluster_parameters
Creates, updates, deletes, gets or lists a default_cluster_parameters resource.
Overview
| Name | default_cluster_parameters |
| Type | Resource |
| Id | aws.redshift.default_cluster_parameters |
Fields
The following fields are returned by SELECT queries:
- describe_default_cluster_parameters
| Name | Datatype | Description |
|---|---|---|
marker | string | A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request. |
parameter_group_family | string | The name of the cluster parameter group family to which the engine default parameters apply. |
parameters | string | The list of cluster default parameters. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_default_cluster_parameters | select | ParameterGroupFamily, region | MaxRecords, Marker | Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management 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 |
|---|---|---|
ParameterGroupFamily | string | The name of the cluster parameter group family. |
region | string | AWS region (default: us-east-1) |
Marker | string | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. |
MaxRecords | integer | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. |
SELECT examples
- describe_default_cluster_parameters
Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
SELECT
marker,
parameter_group_family,
parameters
FROM aws.redshift.default_cluster_parameters
WHERE ParameterGroupFamily = '{{ ParameterGroupFamily }}' -- required
AND region = '{{ region }}' -- required
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;