CreateClusterParameterGroup - Amazon Redshift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateClusterParameterGroup

Creates an Amazon Redshift parameter group.

Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.

Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Description

A description of the parameter group.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

ParameterGroupFamily

The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your Amazon Web Services account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

ParameterGroupName

The name of the cluster parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique withing your Amazon Web Services account.

Note

This value is stored as a lower-case string.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

Tags.Tag.N

A list of tag instances.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

ClusterParameterGroup

Describes a parameter group.

Type: ClusterParameterGroup object

Errors

For information about the errors that are common to all actions, see Common Errors.

ClusterParameterGroupAlreadyExists

A cluster parameter group with the same name already exists.

HTTP Status Code: 400

ClusterParameterGroupQuotaExceeded

The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

HTTP Status Code: 400

InvalidTagFault

The tag is invalid.

HTTP Status Code: 400

TagLimitExceededFault

You have exceeded the number of tags allowed.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateClusterParameterGroup.

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=CreateClusterParameterGroup &ParameterGroupName=myclusterparametergroup &ParameterGroupFamily=redshift-1.0 &Description=My+first+cluster+parameter+group &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request &X-Amz-Date=20190825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<CreateClusterParameterGroupResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <CreateClusterParameterGroupResult> <ClusterParameterGroup> <ParameterGroupName>myclusterparametergroup</ParameterGroupName> <Description>My first cluster parameter group</Description> <ParameterGroupFamily>redshift-1.0</ParameterGroupFamily> <Tags/> </ClusterParameterGroup> </CreateClusterParameterGroupResult> <ResponseMetadata> <RequestId>d52df43b-281e-11ea-8314-974e2ba81189</RequestId> </ResponseMetadata> </CreateClusterParameterGroupResponse>