Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Redshift Resource Types Reference » AWS::Redshift::ClusterParameterGroup

AWS::Redshift::ClusterParameterGroup

Creates an Amazon Redshift parameter group that you can associate with an Amazon Redshift cluster. The parameters in the group apply to all the databases that you create in the cluster.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Redshift::ClusterParameterGroup",
  "Properties" : {
    "Description" : String,
    "ParameterGroupFamily" : String,
    "Parameters" : [ Parameter, ... ],
    "Tags" : [ Resource Tag, ... ]
  }
}

YAML

Type: "AWS::Redshift::ClusterParameterGroup"
Properties: 
  Description: String
  ParameterGroupFamily: String
  Parameters:
    - Parameter
  Tags:
    - Resource Tag

Properties

Description

A description of the parameter group.

Required: Yes

Type: String

Update requires: Replacement

ParameterGroupFamily

The Amazon Redshift engine version that applies to this cluster parameter group. The cluster engine version determines the set of parameters that you can specify in the Parameters property.

Required: Yes

Type: String

Update requires: Replacement

Parameters

A list of parameter names and values that are allowed by the Amazon Redshift engine version that you specified in the ParameterGroupFamily property. For more information, see Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Required: No

Type: Amazon Redshift Parameter Type

Update requires: No interruption

Tags

Specifies an arbitrary set of tags (key–value pairs) to associate with this parameter group. Use tags to manage your resources.

Required: No

Type: Resource Tag

Update requires: No interruption

Return Values

Ref

When the logical ID of this resource is provided to the Ref intrinsic 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 is 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