Redshift / Client / create_cluster_parameter_group

create_cluster_parameter_group

Redshift.Client.create_cluster_parameter_group(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_cluster_parameter_group(
    ParameterGroupName='string',
    ParameterGroupFamily='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ParameterGroupName (string) –

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

  Note

  This value is stored as a lower-case string.

• ParameterGroupFamily (string) –

  [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 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”.

• Description (string) –

  [REQUIRED]

  A description of the parameter group.

• Tags (list) –

  A list of tag instances.

  • (dict) –

    A tag consisting of a name/value pair for a resource.

    • Key (string) –

      The key, or name, for the resource tag.

    • Value (string) –

      The value for the resource tag.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterParameterGroup': {
        'ParameterGroupName': 'string',
        'ParameterGroupFamily': 'string',
        'Description': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • ClusterParameterGroup (dict) –

    Describes a parameter group.

    • ParameterGroupName (string) –

      The name of the cluster parameter group.

    • ParameterGroupFamily (string) –

      The name of the cluster parameter group family that this cluster parameter group is compatible with.

    • Description (string) –

      The description of the parameter group.

    • Tags (list) –

      The list of tags for the cluster parameter group.

      • (dict) –

        A tag consisting of a name/value pair for a resource.

        • Key (string) –

          The key, or name, for the resource tag.

        • Value (string) –

          The value for the resource tag.

Exceptions

• Redshift.Client.exceptions.ClusterParameterGroupQuotaExceededFault

• Redshift.Client.exceptions.ClusterParameterGroupAlreadyExistsFault

• Redshift.Client.exceptions.TagLimitExceededFault

• Redshift.Client.exceptions.InvalidTagFault