Skip to content

Create Cluster Parameter Group

redshift_create_cluster_parameter_group R Documentation

Creates an Amazon Redshift parameter group

Description

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 modify_cluster.

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.

Usage

redshift_create_cluster_parameter_group(ParameterGroupName,
  ParameterGroupFamily, Description, Tags)

Arguments

ParameterGroupName

[required] 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.

This value is stored as a lower-case string.

ParameterGroupFamily

[required] 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 describe_cluster_parameter_groups. 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".

Description

[required] A description of the parameter group.

Tags

A list of tag instances.

Value

A list with the following syntax: 

list(
  ClusterParameterGroup = list(
    ParameterGroupName = "string",
    ParameterGroupFamily = "string",
    Description = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$create_cluster_parameter_group(
  ParameterGroupName = "string",
  ParameterGroupFamily = "string",
  Description = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)