Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElastiCache.ModifyGlobalReplicationGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the settings for a Global datastore.

Synopsis

data ModifyGlobalReplicationGroup = ModifyGlobalReplicationGroup' {
- automaticFailoverEnabled :: Maybe Bool
- cacheNodeType :: Maybe Text
- cacheParameterGroupName :: Maybe Text
- engineVersion :: Maybe Text
- globalReplicationGroupDescription :: Maybe Text
- globalReplicationGroupId :: Text
- applyImmediately :: Bool
}
newModifyGlobalReplicationGroup :: Text -> Bool -> ModifyGlobalReplicationGroup
modifyGlobalReplicationGroup_automaticFailoverEnabled :: Lens' ModifyGlobalReplicationGroup (Maybe Bool)
modifyGlobalReplicationGroup_cacheNodeType :: Lens' ModifyGlobalReplicationGroup (Maybe Text)
modifyGlobalReplicationGroup_cacheParameterGroupName :: Lens' ModifyGlobalReplicationGroup (Maybe Text)
modifyGlobalReplicationGroup_engineVersion :: Lens' ModifyGlobalReplicationGroup (Maybe Text)
modifyGlobalReplicationGroup_globalReplicationGroupDescription :: Lens' ModifyGlobalReplicationGroup (Maybe Text)
modifyGlobalReplicationGroup_globalReplicationGroupId :: Lens' ModifyGlobalReplicationGroup Text
modifyGlobalReplicationGroup_applyImmediately :: Lens' ModifyGlobalReplicationGroup Bool
data ModifyGlobalReplicationGroupResponse = ModifyGlobalReplicationGroupResponse' {
- globalReplicationGroup :: Maybe GlobalReplicationGroup
- httpStatus :: Int
}
newModifyGlobalReplicationGroupResponse :: Int -> ModifyGlobalReplicationGroupResponse
modifyGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' ModifyGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)
modifyGlobalReplicationGroupResponse_httpStatus :: Lens' ModifyGlobalReplicationGroupResponse Int

Creating a Request

data ModifyGlobalReplicationGroup Source #

See: newModifyGlobalReplicationGroup smart constructor.

Constructors

ModifyGlobalReplicationGroup'

Fields

automaticFailoverEnabled :: Maybe Bool
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
cacheNodeType :: Maybe Text
A valid cache node type that you want to scale this Global datastore to.
cacheParameterGroupName :: Maybe Text
The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
engineVersion :: Maybe Text
The upgraded version of the cache engine to be run on the clusters in the Global datastore.
globalReplicationGroupDescription :: Maybe Text
A description of the Global datastore
globalReplicationGroupId :: Text
The name of the Global datastore
applyImmediately :: Bool
This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

Instances

Instances details

ToHeaders ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods toHeaders :: ModifyGlobalReplicationGroup -> [Header] #
ToPath ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods toPath :: ModifyGlobalReplicationGroup -> ByteString #
ToQuery ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods toQuery :: ModifyGlobalReplicationGroup -> QueryString #
AWSRequest ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Associated Types type AWSResponse ModifyGlobalReplicationGroup # Methods request :: (Service -> Service) -> ModifyGlobalReplicationGroup -> Request ModifyGlobalReplicationGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyGlobalReplicationGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyGlobalReplicationGroup))) #
Generic ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Associated Types type Rep ModifyGlobalReplicationGroup :: Type -> Type # Methods from :: ModifyGlobalReplicationGroup -> Rep ModifyGlobalReplicationGroup x # to :: Rep ModifyGlobalReplicationGroup x -> ModifyGlobalReplicationGroup #
Read ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods readsPrec :: Int -> ReadS ModifyGlobalReplicationGroup # readList :: ReadS [ModifyGlobalReplicationGroup] # readPrec :: ReadPrec ModifyGlobalReplicationGroup # readListPrec :: ReadPrec [ModifyGlobalReplicationGroup] #
Show ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods showsPrec :: Int -> ModifyGlobalReplicationGroup -> ShowS # show :: ModifyGlobalReplicationGroup -> String # showList :: [ModifyGlobalReplicationGroup] -> ShowS #
NFData ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods rnf :: ModifyGlobalReplicationGroup -> () #
Eq ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods (==) :: ModifyGlobalReplicationGroup -> ModifyGlobalReplicationGroup -> Bool # (/=) :: ModifyGlobalReplicationGroup -> ModifyGlobalReplicationGroup -> Bool #
Hashable ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods hashWithSalt :: Int -> ModifyGlobalReplicationGroup -> Int # hash :: ModifyGlobalReplicationGroup -> Int #
type AWSResponse ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup type AWSResponse ModifyGlobalReplicationGroup = ModifyGlobalReplicationGroupResponse
type Rep ModifyGlobalReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup type Rep ModifyGlobalReplicationGroup = D1 ('MetaData "ModifyGlobalReplicationGroup" "Amazonka.ElastiCache.ModifyGlobalReplicationGroup" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "ModifyGlobalReplicationGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "automaticFailoverEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "cacheNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cacheParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "globalReplicationGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "globalReplicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newModifyGlobalReplicationGroup Source #

Arguments

:: Text	`ModifyGlobalReplicationGroup`
-> Bool	`$sel:applyImmediately:ModifyGlobalReplicationGroup'`
-> ModifyGlobalReplicationGroup

Create a value of ModifyGlobalReplicationGroup 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:automaticFailoverEnabled:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_automaticFailoverEnabled - Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

ModifyGlobalReplicationGroup, modifyGlobalReplicationGroup_cacheNodeType - A valid cache node type that you want to scale this Global datastore to.

ModifyGlobalReplicationGroup, modifyGlobalReplicationGroup_cacheParameterGroupName - The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

ModifyGlobalReplicationGroup, modifyGlobalReplicationGroup_engineVersion - The upgraded version of the cache engine to be run on the clusters in the Global datastore.

ModifyGlobalReplicationGroup, modifyGlobalReplicationGroup_globalReplicationGroupDescription - A description of the Global datastore

ModifyGlobalReplicationGroup, modifyGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore

$sel:applyImmediately:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_applyImmediately - This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

Request Lenses

modifyGlobalReplicationGroup_automaticFailoverEnabled :: Lens' ModifyGlobalReplicationGroup (Maybe Bool) Source #

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

modifyGlobalReplicationGroup_cacheNodeType :: Lens' ModifyGlobalReplicationGroup (Maybe Text) Source #

A valid cache node type that you want to scale this Global datastore to.

modifyGlobalReplicationGroup_cacheParameterGroupName :: Lens' ModifyGlobalReplicationGroup (Maybe Text) Source #

The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

modifyGlobalReplicationGroup_engineVersion :: Lens' ModifyGlobalReplicationGroup (Maybe Text) Source #

The upgraded version of the cache engine to be run on the clusters in the Global datastore.

modifyGlobalReplicationGroup_globalReplicationGroupDescription :: Lens' ModifyGlobalReplicationGroup (Maybe Text) Source #

A description of the Global datastore

modifyGlobalReplicationGroup_globalReplicationGroupId :: Lens' ModifyGlobalReplicationGroup Text Source #

The name of the Global datastore

modifyGlobalReplicationGroup_applyImmediately :: Lens' ModifyGlobalReplicationGroup Bool Source #

This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

Destructuring the Response

data ModifyGlobalReplicationGroupResponse Source #

See: newModifyGlobalReplicationGroupResponse smart constructor.

Constructors

ModifyGlobalReplicationGroupResponse'
Fields globalReplicationGroup :: Maybe GlobalReplicationGroup httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ModifyGlobalReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Associated Types type Rep ModifyGlobalReplicationGroupResponse :: Type -> Type # Methods from :: ModifyGlobalReplicationGroupResponse -> Rep ModifyGlobalReplicationGroupResponse x # to :: Rep ModifyGlobalReplicationGroupResponse x -> ModifyGlobalReplicationGroupResponse #
Read ModifyGlobalReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods readsPrec :: Int -> ReadS ModifyGlobalReplicationGroupResponse # readList :: ReadS [ModifyGlobalReplicationGroupResponse] # readPrec :: ReadPrec ModifyGlobalReplicationGroupResponse # readListPrec :: ReadPrec [ModifyGlobalReplicationGroupResponse] #
Show ModifyGlobalReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods showsPrec :: Int -> ModifyGlobalReplicationGroupResponse -> ShowS # show :: ModifyGlobalReplicationGroupResponse -> String # showList :: [ModifyGlobalReplicationGroupResponse] -> ShowS #
NFData ModifyGlobalReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods rnf :: ModifyGlobalReplicationGroupResponse -> () #
Eq ModifyGlobalReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup Methods (==) :: ModifyGlobalReplicationGroupResponse -> ModifyGlobalReplicationGroupResponse -> Bool # (/=) :: ModifyGlobalReplicationGroupResponse -> ModifyGlobalReplicationGroupResponse -> Bool #
type Rep ModifyGlobalReplicationGroupResponse Source #
Instance details Defined in Amazonka.ElastiCache.ModifyGlobalReplicationGroup type Rep ModifyGlobalReplicationGroupResponse = D1 ('MetaData "ModifyGlobalReplicationGroupResponse" "Amazonka.ElastiCache.ModifyGlobalReplicationGroup" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "ModifyGlobalReplicationGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalReplicationGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalReplicationGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyGlobalReplicationGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:ModifyGlobalReplicationGroupResponse'`
-> ModifyGlobalReplicationGroupResponse

Create a value of ModifyGlobalReplicationGroupResponse 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:globalReplicationGroup:ModifyGlobalReplicationGroupResponse', modifyGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.

$sel:httpStatus:ModifyGlobalReplicationGroupResponse', modifyGlobalReplicationGroupResponse_httpStatus - The response's http status code.

Response Lenses

modifyGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' ModifyGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup) Source #

Undocumented member.

modifyGlobalReplicationGroupResponse_httpStatus :: Lens' ModifyGlobalReplicationGroupResponse Int Source #

The response's http status code.