libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.CreateClusterParameterGroup

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

Synopsis

Creating a Request

data CreateClusterParameterGroup Source #

See: newCreateClusterParameterGroup smart constructor.

Constructors

CreateClusterParameterGroup' 

Fields

  • tags :: Maybe [Tag]

    A list of tag instances.

  • parameterGroupName :: Text

    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 :: Text

    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 :: Text

    A description of the parameter group.

Instances

Instances details
Eq CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

(==) :: CreateClusterParameterGroup -> CreateClusterParameterGroup -> Bool #

(/=) :: CreateClusterParameterGroup -> CreateClusterParameterGroup -> Bool #

Read CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

readsPrec :: Int -> ReadS CreateClusterParameterGroup #

readList :: ReadS [CreateClusterParameterGroup] #

readPrec :: ReadPrec CreateClusterParameterGroup #

readListPrec :: ReadPrec [CreateClusterParameterGroup] #

Show CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

showsPrec :: Int -> CreateClusterParameterGroup -> ShowS #

show :: CreateClusterParameterGroup -> String #

showList :: [CreateClusterParameterGroup] -> ShowS #

Generic CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Associated Types

type Rep CreateClusterParameterGroup :: Type -> Type #

Methods

from :: CreateClusterParameterGroup -> Rep CreateClusterParameterGroup x #

to :: Rep CreateClusterParameterGroup x -> CreateClusterParameterGroup #

NFData CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

rnf :: CreateClusterParameterGroup -> () #

Hashable CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

hashWithSalt :: Int -> CreateClusterParameterGroup -> Int #

hash :: CreateClusterParameterGroup -> Int #

AWSRequest CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Associated Types

type AWSResponse CreateClusterParameterGroup #

Methods

request :: CreateClusterParameterGroup -> Request CreateClusterParameterGroup #

response :: MonadResource m => Logger -> Service -> Proxy CreateClusterParameterGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateClusterParameterGroup))) #

ToHeaders CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

toHeaders :: CreateClusterParameterGroup -> [Header] #

ToPath CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

toPath :: CreateClusterParameterGroup -> ByteString #

ToQuery CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

toQuery :: CreateClusterParameterGroup -> QueryString #

type Rep CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

type Rep CreateClusterParameterGroup = D1 ('MetaData "CreateClusterParameterGroup" "Amazonka.Redshift.CreateClusterParameterGroup" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "CreateClusterParameterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "parameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

type AWSResponse CreateClusterParameterGroup = CreateClusterParameterGroupResponse

newCreateClusterParameterGroup Source #

Arguments

:: Text

$sel:parameterGroupName:CreateClusterParameterGroup'

-> Text

$sel:parameterGroupFamily:CreateClusterParameterGroup'

-> Text

$sel:description:CreateClusterParameterGroup'

-> CreateClusterParameterGroup 

Create a value of CreateClusterParameterGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tags:CreateClusterParameterGroup', createClusterParameterGroup_tags - A list of tag instances.

$sel:parameterGroupName:CreateClusterParameterGroup', createClusterParameterGroup_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.

This value is stored as a lower-case string.

$sel:parameterGroupFamily:CreateClusterParameterGroup', createClusterParameterGroup_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".

$sel:description:CreateClusterParameterGroup', createClusterParameterGroup_description - A description of the parameter group.

Request Lenses

createClusterParameterGroup_tags :: Lens' CreateClusterParameterGroup (Maybe [Tag]) Source #

A list of tag instances.

createClusterParameterGroup_parameterGroupName :: Lens' CreateClusterParameterGroup Text Source #

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.

createClusterParameterGroup_parameterGroupFamily :: Lens' CreateClusterParameterGroup Text Source #

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

createClusterParameterGroup_description :: Lens' CreateClusterParameterGroup Text Source #

A description of the parameter group.

Destructuring the Response

data CreateClusterParameterGroupResponse Source #

See: newCreateClusterParameterGroupResponse smart constructor.

Constructors

CreateClusterParameterGroupResponse' 

Fields

Instances

Instances details
Eq CreateClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

(==) :: CreateClusterParameterGroupResponse -> CreateClusterParameterGroupResponse -> Bool #

(/=) :: CreateClusterParameterGroupResponse -> CreateClusterParameterGroupResponse -> Bool #

Read CreateClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

readsPrec :: Int -> ReadS CreateClusterParameterGroupResponse #

readList :: ReadS [CreateClusterParameterGroupResponse] #

readPrec :: ReadPrec CreateClusterParameterGroupResponse #

readListPrec :: ReadPrec [CreateClusterParameterGroupResponse] #

Show CreateClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

showsPrec :: Int -> CreateClusterParameterGroupResponse -> ShowS #

show :: CreateClusterParameterGroupResponse -> String #

showList :: [CreateClusterParameterGroupResponse] -> ShowS #

Generic CreateClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Associated Types

type Rep CreateClusterParameterGroupResponse :: Type -> Type #

Methods

from :: CreateClusterParameterGroupResponse -> Rep CreateClusterParameterGroupResponse x #

to :: Rep CreateClusterParameterGroupResponse x -> CreateClusterParameterGroupResponse #

NFData CreateClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

Methods

rnf :: CreateClusterParameterGroupResponse -> () #

type Rep CreateClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.Redshift.CreateClusterParameterGroup

type Rep CreateClusterParameterGroupResponse = D1 ('MetaData "CreateClusterParameterGroupResponse" "Amazonka.Redshift.CreateClusterParameterGroup" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "CreateClusterParameterGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterParameterGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateClusterParameterGroupResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateClusterParameterGroupResponse'

-> CreateClusterParameterGroupResponse 

Create a value of CreateClusterParameterGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clusterParameterGroup:CreateClusterParameterGroupResponse', createClusterParameterGroupResponse_clusterParameterGroup - Undocumented member.

$sel:httpStatus:CreateClusterParameterGroupResponse', createClusterParameterGroupResponse_httpStatus - The response's http status code.

Response Lenses

createClusterParameterGroupResponse_clusterParameterGroup :: Lens' CreateClusterParameterGroupResponse (Maybe ClusterParameterGroup) Source #

Undocumented member.

createClusterParameterGroupResponse_httpStatus :: Lens' CreateClusterParameterGroupResponse Int Source #

The response's http status code.