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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deleting a Global datastore is a two-step process:

First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

Synopsis

data DeleteGlobalReplicationGroup = DeleteGlobalReplicationGroup' {
- globalReplicationGroupId :: Text
- retainPrimaryReplicationGroup :: Bool
}
newDeleteGlobalReplicationGroup :: Text -> Bool -> DeleteGlobalReplicationGroup
deleteGlobalReplicationGroup_globalReplicationGroupId :: Lens' DeleteGlobalReplicationGroup Text
deleteGlobalReplicationGroup_retainPrimaryReplicationGroup :: Lens' DeleteGlobalReplicationGroup Bool
data DeleteGlobalReplicationGroupResponse = DeleteGlobalReplicationGroupResponse' {
- globalReplicationGroup :: Maybe GlobalReplicationGroup
- httpStatus :: Int
}
newDeleteGlobalReplicationGroupResponse :: Int -> DeleteGlobalReplicationGroupResponse
deleteGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' DeleteGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup)
deleteGlobalReplicationGroupResponse_httpStatus :: Lens' DeleteGlobalReplicationGroupResponse Int

Creating a Request

data DeleteGlobalReplicationGroup Source #

See: newDeleteGlobalReplicationGroup smart constructor.

Constructors

DeleteGlobalReplicationGroup'
Fields globalReplicationGroupId :: Text The name of the Global datastore retainPrimaryReplicationGroup :: Bool The primary replication group is retained as a standalone replication group.

Instances

Instances details

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

newDeleteGlobalReplicationGroup Source #

Arguments

:: Text	`DeleteGlobalReplicationGroup`
-> Bool	`$sel:retainPrimaryReplicationGroup:DeleteGlobalReplicationGroup'`
-> DeleteGlobalReplicationGroup

Create a value of DeleteGlobalReplicationGroup 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:

DeleteGlobalReplicationGroup, deleteGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore

$sel:retainPrimaryReplicationGroup:DeleteGlobalReplicationGroup', deleteGlobalReplicationGroup_retainPrimaryReplicationGroup - The primary replication group is retained as a standalone replication group.

Request Lenses

deleteGlobalReplicationGroup_globalReplicationGroupId :: Lens' DeleteGlobalReplicationGroup Text Source #

The name of the Global datastore

deleteGlobalReplicationGroup_retainPrimaryReplicationGroup :: Lens' DeleteGlobalReplicationGroup Bool Source #

The primary replication group is retained as a standalone replication group.

Destructuring the Response

data DeleteGlobalReplicationGroupResponse Source #

See: newDeleteGlobalReplicationGroupResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDeleteGlobalReplicationGroupResponse Source #

Arguments

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

Create a value of DeleteGlobalReplicationGroupResponse 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:DeleteGlobalReplicationGroupResponse', deleteGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.

$sel:httpStatus:DeleteGlobalReplicationGroupResponse', deleteGlobalReplicationGroupResponse_httpStatus - The response's http status code.

Response Lenses

deleteGlobalReplicationGroupResponse_globalReplicationGroup :: Lens' DeleteGlobalReplicationGroupResponse (Maybe GlobalReplicationGroup) Source #

Undocumented member.

deleteGlobalReplicationGroupResponse_httpStatus :: Lens' DeleteGlobalReplicationGroupResponse Int Source #

The response's http status code.