Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.CreateDBClusterParameterGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new cluster parameter group.

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

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

Synopsis

Creating a Request

data CreateDBClusterParameterGroup Source #

Represents the input of CreateDBClusterParameterGroup.

See: newCreateDBClusterParameterGroup smart constructor.

Constructors

CreateDBClusterParameterGroup'

Fields

tags :: Maybe [Tag]
The tags to be assigned to the cluster parameter group.
dbClusterParameterGroupName :: Text
The name of the cluster parameter group.
Constraints:
- Must not match the name of an existing DBClusterParameterGroup.
This value is stored as a lowercase string.
dbParameterGroupFamily :: Text
The cluster parameter group family name.
description :: Text
The description for the cluster parameter group.

Instances

Instances details

Eq CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods (==) :: CreateDBClusterParameterGroup -> CreateDBClusterParameterGroup -> Bool # (/=) :: CreateDBClusterParameterGroup -> CreateDBClusterParameterGroup -> Bool #
Read CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods readsPrec :: Int -> ReadS CreateDBClusterParameterGroup # readList :: ReadS [CreateDBClusterParameterGroup] # readPrec :: ReadPrec CreateDBClusterParameterGroup # readListPrec :: ReadPrec [CreateDBClusterParameterGroup] #
Show CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods showsPrec :: Int -> CreateDBClusterParameterGroup -> ShowS # show :: CreateDBClusterParameterGroup -> String # showList :: [CreateDBClusterParameterGroup] -> ShowS #
Generic CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.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.DocumentDB.CreateDBClusterParameterGroup Methods rnf :: CreateDBClusterParameterGroup -> () #
Hashable CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods hashWithSalt :: Int -> CreateDBClusterParameterGroup -> Int # hash :: CreateDBClusterParameterGroup -> Int #
AWSRequest CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.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.DocumentDB.CreateDBClusterParameterGroup Methods toHeaders :: CreateDBClusterParameterGroup -> [Header] #
ToPath CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods toPath :: CreateDBClusterParameterGroup -> ByteString #
ToQuery CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods toQuery :: CreateDBClusterParameterGroup -> QueryString #
type Rep CreateDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup type Rep CreateDBClusterParameterGroup = D1 ('MetaData "CreateDBClusterParameterGroup" "Amazonka.DocumentDB.CreateDBClusterParameterGroup" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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.DocumentDB.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 - The tags to be assigned to the cluster parameter group.

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

Constraints:

Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

$sel:dbParameterGroupFamily:CreateDBClusterParameterGroup', createDBClusterParameterGroup_dbParameterGroupFamily - The cluster parameter group family name.

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

Request Lenses

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

The tags to be assigned to the cluster parameter group.

createDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' CreateDBClusterParameterGroup Text Source #

The name of the cluster parameter group.

Constraints:

Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

createDBClusterParameterGroup_dbParameterGroupFamily :: Lens' CreateDBClusterParameterGroup Text Source #

The cluster parameter group family name.

createDBClusterParameterGroup_description :: Lens' CreateDBClusterParameterGroup Text Source #

The description for the cluster parameter group.

Destructuring the Response

data CreateDBClusterParameterGroupResponse Source #

See: newCreateDBClusterParameterGroupResponse smart constructor.

Constructors

CreateDBClusterParameterGroupResponse'
Fields dbClusterParameterGroup :: Maybe DBClusterParameterGroup httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateDBClusterParameterGroupResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods (==) :: CreateDBClusterParameterGroupResponse -> CreateDBClusterParameterGroupResponse -> Bool # (/=) :: CreateDBClusterParameterGroupResponse -> CreateDBClusterParameterGroupResponse -> Bool #
Read CreateDBClusterParameterGroupResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods readsPrec :: Int -> ReadS CreateDBClusterParameterGroupResponse # readList :: ReadS [CreateDBClusterParameterGroupResponse] # readPrec :: ReadPrec CreateDBClusterParameterGroupResponse # readListPrec :: ReadPrec [CreateDBClusterParameterGroupResponse] #
Show CreateDBClusterParameterGroupResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup Methods showsPrec :: Int -> CreateDBClusterParameterGroupResponse -> ShowS # show :: CreateDBClusterParameterGroupResponse -> String # showList :: [CreateDBClusterParameterGroupResponse] -> ShowS #
Generic CreateDBClusterParameterGroupResponse Source #
Instance details Defined in Amazonka.DocumentDB.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.DocumentDB.CreateDBClusterParameterGroup Methods rnf :: CreateDBClusterParameterGroupResponse -> () #
type Rep CreateDBClusterParameterGroupResponse Source #
Instance details Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup type Rep CreateDBClusterParameterGroupResponse = D1 ('MetaData "CreateDBClusterParameterGroupResponse" "Amazonka.DocumentDB.CreateDBClusterParameterGroup" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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.