Describes a parameter group.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Redshift::ClusterParameterGroup",
"Properties" : {
"Description" : String,
"ParameterGroupFamily" : String,
"ParameterGroupName" : String,
"Parameters" : [ Parameter, ... ],
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::Redshift::ClusterParameterGroup
Properties:
Description: String
ParameterGroupFamily: String
ParameterGroupName: String
Parameters:
- Parameter
Tags:
- Tag
Properties
Description-
The description of the parameter group.
Required: Yes
Type: String
Maximum:
2147483647Update requires: Replacement
ParameterGroupFamily-
The name of the cluster parameter group family that this cluster parameter group is compatible with. You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups.
Required: Yes
Type: String
Maximum:
2147483647Update requires: Replacement
ParameterGroupName-
The name of the cluster parameter group.
Required: No
Type: String
Maximum:
255Update requires: Replacement
Parameters-
An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
Required: No
Type: Array of Parameter
Update requires: No interruption
-
The list of tags for the cluster parameter group.
Required: No
Type: Array of Tag
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:
{ "Ref": "myClusterParameterGroup" }
For the Amazon Redshift cluster parameter group
myClusterParameterGroup, Ref returns the name of the cluster
parameter group.
For more information about using the Ref function, see Ref.
Examples
Single Parameter
The following example describes a parameter group with one parameter that's specified:
JSON
"myClusterParameterGroup" : {
"Type" : "AWS::Redshift::ClusterParameterGroup",
"Properties" : {
"Description" : "My parameter group",
"ParameterGroupFamily" : "redshift-1.0",
"Parameters" : [ {
"ParameterName" : "enable_user_activity_logging",
"ParameterValue" : "true"
}]
}
}YAML
myClusterParameterGroup:
Type: "AWS::Redshift::ClusterParameterGroup"
Properties:
Description: "My parameter group"
ParameterGroupFamily: "redshift-1.0"
Parameters:
-
ParameterName: "enable_user_activity_logging"
ParameterValue: "true"Workload Management Configuration
The following example modifies the workload management configuration using the
wlm_json_configuration parameter. The parameter value is a JSON
object that must be passed as a string enclosed in quotation marks (").
JSON
"RedshiftClusterParameterGroup": {
"Type": "AWS::Redshift::ClusterParameterGroup",
"Properties": {
"Description": "Cluster parameter group",
"ParameterGroupFamily": "redshift-1.0",
"Parameters": [{
"ParameterName": "wlm_json_configuration",
"ParameterValue": "[{\"user_group\":[\"example_user_group1\"],\"query_group\":[\"example_query_group1\"],\"query_concurrency\":7},{\"query_concurrency\":5}]"
}],
"Tags": [
{
"Key": "foo",
"Value": "bar"
}
]
}
}YAML
RedshiftClusterParameterGroup:
Type: "AWS::Redshift::ClusterParameterGroup"
Properties:
Description: "Cluster parameter group"
ParameterGroupFamily: "redshift-1.0"
Parameters:
-
ParameterName: "wlm_json_configuration"
ParameterValue: "[{\"user_group\":[\"example_user_group1\"],\"query_group\":[\"example_query_group1\"],\"query_concurrency\":7},{\"query_concurrency\":5}]"
Tags:
- Key: foo
Value: bar