libZSservicesZSamazonka-rdsZSamazonka-rds
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.RDS.CreateDBClusterParameterGroup

Description

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Synopsis

Creating a Request

data CreateDBClusterParameterGroup Source #

See: newCreateDBClusterParameterGroup smart constructor.

Constructors

CreateDBClusterParameterGroup' 

Fields

  • tags :: Maybe [Tag]

    Tags to assign to the DB cluster parameter group.

  • dbClusterParameterGroupName :: Text

    The name of the DB cluster parameter group.

    Constraints:

    • Must match the name of an existing DB cluster parameter group.

    This value is stored as a lowercase string.

  • dbParameterGroupFamily :: Text

    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

    Aurora MySQL

    Example: aurora5.6, aurora-mysql5.7

    Aurora PostgreSQL

    Example: aurora-postgresql9.6

    To list all of the available parameter group families for a DB engine, use the following command:

    aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

    For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

    aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql

    The output contains duplicates.

    The following are the valid DB engine values:

    • aurora (for MySQL 5.6-compatible Aurora)
    • aurora-mysql (for MySQL 5.7-compatible Aurora)
    • aurora-postgresql
  • description :: Text

    The description for the DB cluster parameter group.

Instances

Instances details
Eq CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

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

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

Read CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

readsPrec :: Int -> ReadS CreateDBClusterParameterGroup #

readList :: ReadS [CreateDBClusterParameterGroup] #

readPrec :: ReadPrec CreateDBClusterParameterGroup #

readListPrec :: ReadPrec [CreateDBClusterParameterGroup] #

Show CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

showsPrec :: Int -> CreateDBClusterParameterGroup -> ShowS #

show :: CreateDBClusterParameterGroup -> String #

showList :: [CreateDBClusterParameterGroup] -> ShowS #

Generic CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Associated Types

type Rep CreateDBClusterParameterGroup :: Type -> Type #

Methods

from :: CreateDBClusterParameterGroup -> Rep CreateDBClusterParameterGroup x #

to :: Rep CreateDBClusterParameterGroup x -> CreateDBClusterParameterGroup #

NFData CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

rnf :: CreateDBClusterParameterGroup -> () #

Hashable CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

hashWithSalt :: Int -> CreateDBClusterParameterGroup -> Int #

hash :: CreateDBClusterParameterGroup -> Int #

AWSRequest CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Associated Types

type AWSResponse CreateDBClusterParameterGroup #

Methods

request :: CreateDBClusterParameterGroup -> Request CreateDBClusterParameterGroup #

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

ToHeaders CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

toHeaders :: CreateDBClusterParameterGroup -> [Header] #

ToPath CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

toPath :: CreateDBClusterParameterGroup -> ByteString #

ToQuery CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

toQuery :: CreateDBClusterParameterGroup -> QueryString #

type Rep CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

type Rep CreateDBClusterParameterGroup = D1 ('MetaData "CreateDBClusterParameterGroup" "Amazonka.RDS.CreateDBClusterParameterGroup" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CreateDBClusterParameterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

type AWSResponse CreateDBClusterParameterGroup = CreateDBClusterParameterGroupResponse

newCreateDBClusterParameterGroup Source #

Arguments

:: Text

$sel:dbClusterParameterGroupName:CreateDBClusterParameterGroup'

-> Text

$sel:dbParameterGroupFamily:CreateDBClusterParameterGroup'

-> Text

$sel:description:CreateDBClusterParameterGroup'

-> CreateDBClusterParameterGroup 

Create a value of CreateDBClusterParameterGroup 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:CreateDBClusterParameterGroup', createDBClusterParameterGroup_tags - Tags to assign to the DB cluster parameter group.

$sel:dbClusterParameterGroupName:CreateDBClusterParameterGroup', createDBClusterParameterGroup_dbClusterParameterGroupName - The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

$sel:dbParameterGroupFamily:CreateDBClusterParameterGroup', createDBClusterParameterGroup_dbParameterGroupFamily - The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7

Aurora PostgreSQL

Example: aurora-postgresql9.6

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql

The output contains duplicates.

The following are the valid DB engine values:

  • aurora (for MySQL 5.6-compatible Aurora)
  • aurora-mysql (for MySQL 5.7-compatible Aurora)
  • aurora-postgresql

$sel:description:CreateDBClusterParameterGroup', createDBClusterParameterGroup_description - The description for the DB cluster parameter group.

Request Lenses

createDBClusterParameterGroup_tags :: Lens' CreateDBClusterParameterGroup (Maybe [Tag]) Source #

Tags to assign to the DB cluster parameter group.

createDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' CreateDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

createDBClusterParameterGroup_dbParameterGroupFamily :: Lens' CreateDBClusterParameterGroup Text Source #

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7

Aurora PostgreSQL

Example: aurora-postgresql9.6

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql

The output contains duplicates.

The following are the valid DB engine values:

  • aurora (for MySQL 5.6-compatible Aurora)
  • aurora-mysql (for MySQL 5.7-compatible Aurora)
  • aurora-postgresql

createDBClusterParameterGroup_description :: Lens' CreateDBClusterParameterGroup Text Source #

The description for the DB cluster parameter group.

Destructuring the Response

data CreateDBClusterParameterGroupResponse Source #

See: newCreateDBClusterParameterGroupResponse smart constructor.

Constructors

CreateDBClusterParameterGroupResponse' 

Fields

Instances

Instances details
Eq CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

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

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

Read CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

readsPrec :: Int -> ReadS CreateDBClusterParameterGroupResponse #

readList :: ReadS [CreateDBClusterParameterGroupResponse] #

readPrec :: ReadPrec CreateDBClusterParameterGroupResponse #

readListPrec :: ReadPrec [CreateDBClusterParameterGroupResponse] #

Show CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

showsPrec :: Int -> CreateDBClusterParameterGroupResponse -> ShowS #

show :: CreateDBClusterParameterGroupResponse -> String #

showList :: [CreateDBClusterParameterGroupResponse] -> ShowS #

Generic CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Associated Types

type Rep CreateDBClusterParameterGroupResponse :: Type -> Type #

Methods

from :: CreateDBClusterParameterGroupResponse -> Rep CreateDBClusterParameterGroupResponse x #

to :: Rep CreateDBClusterParameterGroupResponse x -> CreateDBClusterParameterGroupResponse #

NFData CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

Methods

rnf :: CreateDBClusterParameterGroupResponse -> () #

type Rep CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBClusterParameterGroup

type Rep CreateDBClusterParameterGroupResponse = D1 ('MetaData "CreateDBClusterParameterGroupResponse" "Amazonka.RDS.CreateDBClusterParameterGroup" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CreateDBClusterParameterGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterParameterGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBClusterParameterGroupResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateDBClusterParameterGroupResponse'

-> CreateDBClusterParameterGroupResponse 

Create a value of CreateDBClusterParameterGroupResponse 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:dbClusterParameterGroup:CreateDBClusterParameterGroupResponse', createDBClusterParameterGroupResponse_dbClusterParameterGroup - Undocumented member.

$sel:httpStatus:CreateDBClusterParameterGroupResponse', createDBClusterParameterGroupResponse_httpStatus - The response's http status code.

Response Lenses

createDBClusterParameterGroupResponse_dbClusterParameterGroup :: Lens' CreateDBClusterParameterGroupResponse (Maybe DBClusterParameterGroup) Source #

Undocumented member.

createDBClusterParameterGroupResponse_httpStatus :: Lens' CreateDBClusterParameterGroupResponse Int Source #

The response's http status code.