cluster_parameters

Creates, updates, deletes, gets or lists a cluster_parameters resource.

Overview

Name	cluster_parameters
Type	Resource
Id	aws.redshift.cluster_parameters

Fields

The following fields are returned by SELECT queries:

describe_cluster_parameters

Name	Datatype	Description
allowed_values	string	The valid range of values for the parameter.
apply_type	string	Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
data_type	string	The data type of the parameter.
description	string	A description of the parameter.
is_modifiable	boolean	If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
minimum_engine_version	string	The earliest engine version to which the parameter can apply.
parameter_name	string	The name of the parameter.
parameter_value	string	The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.
source	string	The source of the parameter value, such as "engine-default" or "user".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster_parameters	select	ParameterGroupName, region	Source, MaxRecords, Marker	Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
reset_cluster_parameter_group	exec	ParameterGroupName, region	ResetAllParameters, Parameters	Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

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
ParameterGroupName	string	The name of the cluster parameter group to be reset.
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 DescribeClusterParameters 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.
Parameters	array	An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied. Constraints: A maximum of 20 parameters can be reset in a single request.
ResetAllParameters	boolean	If true, all parameters in the specified parameter group will be reset to their default values. Default: true
Source	string	The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: user | engine-default

SELECT examples

describe_cluster_parameters

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

SELECT
allowed_values,
apply_type,
data_type,
description,
is_modifiable,
minimum_engine_version,
parameter_name,
parameter_value,
source
FROM aws.redshift.cluster_parameters
WHERE ParameterGroupName = '{{ ParameterGroupName }}' -- required
AND region = '{{ region }}' -- required
AND Source = '{{ Source }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

Lifecycle Methods

reset_cluster_parameter_group

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

EXEC aws.redshift.cluster_parameters.reset_cluster_parameter_group 
@ParameterGroupName='{{ ParameterGroupName }}' --required, 
@region='{{ region }}' --required, 
@ResetAllParameters={{ ResetAllParameters }}, 
@Parameters='{{ Parameters }}'
;