Network.AWS.ElastiCache.DeleteReplicationGroup

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true .

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

Creating a Request

deleteReplicationGroup

Arguments

:: Text

drgReplicationGroupId

-> DeleteReplicationGroup

Creates a value of DeleteReplicationGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• drgFinalSnapshotIdentifier - The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
• drgRetainPrimaryCluster - If set to true , all of the read replicas are deleted, but the primary node is retained.
• drgReplicationGroupId - The identifier for the cluster to be deleted. This parameter is not case sensitive.

data DeleteReplicationGroup

Represents the input of a DeleteReplicationGroup operation.

See: deleteReplicationGroup smart constructor.

Instances

Eq DeleteReplicationGroup

Methods

(==) :: DeleteReplicationGroup -> DeleteReplicationGroup -> Bool

(/=) :: DeleteReplicationGroup -> DeleteReplicationGroup -> Bool

Data DeleteReplicationGroup

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteReplicationGroup -> c DeleteReplicationGroup

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteReplicationGroup

toConstr :: DeleteReplicationGroup -> Constr

dataTypeOf :: DeleteReplicationGroup -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteReplicationGroup)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteReplicationGroup)

gmapT :: (forall b. Data b => b -> b) -> DeleteReplicationGroup -> DeleteReplicationGroup

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteReplicationGroup -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteReplicationGroup -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteReplicationGroup -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteReplicationGroup -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteReplicationGroup -> m DeleteReplicationGroup

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteReplicationGroup -> m DeleteReplicationGroup

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteReplicationGroup -> m DeleteReplicationGroup

Read DeleteReplicationGroup

Methods

readsPrec :: Int -> ReadS DeleteReplicationGroup

readList :: ReadS [DeleteReplicationGroup]

readPrec :: ReadPrec DeleteReplicationGroup

readListPrec :: ReadPrec [DeleteReplicationGroup]

Show DeleteReplicationGroup

Methods

showsPrec :: Int -> DeleteReplicationGroup -> ShowS

show :: DeleteReplicationGroup -> String

showList :: [DeleteReplicationGroup] -> ShowS

Generic DeleteReplicationGroup

Associated Types

type Rep DeleteReplicationGroup :: * -> *

Methods

from :: DeleteReplicationGroup -> Rep DeleteReplicationGroup x

to :: Rep DeleteReplicationGroup x -> DeleteReplicationGroup

Hashable DeleteReplicationGroup

Methods

hashWithSalt :: Int -> DeleteReplicationGroup -> Int

hash :: DeleteReplicationGroup -> Int

NFData DeleteReplicationGroup

Methods

rnf :: DeleteReplicationGroup -> ()

AWSRequest DeleteReplicationGroup

Associated Types

type Rs DeleteReplicationGroup :: *

Methods

request :: DeleteReplicationGroup -> Request DeleteReplicationGroup

response :: MonadResource m => Logger -> Service -> Proxy * DeleteReplicationGroup -> ClientResponse -> m (Response DeleteReplicationGroup)

ToPath DeleteReplicationGroup

Methods

toPath :: DeleteReplicationGroup -> ByteString

ToHeaders DeleteReplicationGroup

Methods

toHeaders :: DeleteReplicationGroup -> [Header]

ToQuery DeleteReplicationGroup

Methods

toQuery :: DeleteReplicationGroup -> QueryString

type Rep DeleteReplicationGroup

type Rep DeleteReplicationGroup = D1 (MetaData "DeleteReplicationGroup" "Network.AWS.ElastiCache.DeleteReplicationGroup" "amazonka-elasticache-1.4.5-DCZ22LKkzpiJjmUycYjUf" False) (C1 (MetaCons "DeleteReplicationGroup'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_drgFinalSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_drgRetainPrimaryCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_drgReplicationGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs DeleteReplicationGroup

type Rs DeleteReplicationGroup = DeleteReplicationGroupResponse

Request Lenses

drgFinalSnapshotIdentifier :: Lens' DeleteReplicationGroup (Maybe Text)

The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

drgRetainPrimaryCluster :: Lens' DeleteReplicationGroup (Maybe Bool)

If set to true , all of the read replicas are deleted, but the primary node is retained.

drgReplicationGroupId :: Lens' DeleteReplicationGroup Text

The identifier for the cluster to be deleted. This parameter is not case sensitive.

Destructuring the Response

deleteReplicationGroupResponse

Arguments

:: Int

delrsResponseStatus

-> DeleteReplicationGroupResponse

Creates a value of DeleteReplicationGroupResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• delrsReplicationGroup - Undocumented member.
• delrsResponseStatus - -- | The response status code.

data DeleteReplicationGroupResponse

See: deleteReplicationGroupResponse smart constructor.

Instances

Eq DeleteReplicationGroupResponse

Methods

(==) :: DeleteReplicationGroupResponse -> DeleteReplicationGroupResponse -> Bool

(/=) :: DeleteReplicationGroupResponse -> DeleteReplicationGroupResponse -> Bool

Data DeleteReplicationGroupResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteReplicationGroupResponse -> c DeleteReplicationGroupResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteReplicationGroupResponse

toConstr :: DeleteReplicationGroupResponse -> Constr

dataTypeOf :: DeleteReplicationGroupResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteReplicationGroupResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteReplicationGroupResponse)

gmapT :: (forall b. Data b => b -> b) -> DeleteReplicationGroupResponse -> DeleteReplicationGroupResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteReplicationGroupResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteReplicationGroupResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteReplicationGroupResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteReplicationGroupResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteReplicationGroupResponse -> m DeleteReplicationGroupResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteReplicationGroupResponse -> m DeleteReplicationGroupResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteReplicationGroupResponse -> m DeleteReplicationGroupResponse

Read DeleteReplicationGroupResponse

Methods

readsPrec :: Int -> ReadS DeleteReplicationGroupResponse

readList :: ReadS [DeleteReplicationGroupResponse]

readPrec :: ReadPrec DeleteReplicationGroupResponse

readListPrec :: ReadPrec [DeleteReplicationGroupResponse]

Show DeleteReplicationGroupResponse

Methods

showsPrec :: Int -> DeleteReplicationGroupResponse -> ShowS

show :: DeleteReplicationGroupResponse -> String

showList :: [DeleteReplicationGroupResponse] -> ShowS

Generic DeleteReplicationGroupResponse

Associated Types

type Rep DeleteReplicationGroupResponse :: * -> *

Methods

from :: DeleteReplicationGroupResponse -> Rep DeleteReplicationGroupResponse x

to :: Rep DeleteReplicationGroupResponse x -> DeleteReplicationGroupResponse

NFData DeleteReplicationGroupResponse

Methods

rnf :: DeleteReplicationGroupResponse -> ()

type Rep DeleteReplicationGroupResponse

type Rep DeleteReplicationGroupResponse = D1 (MetaData "DeleteReplicationGroupResponse" "Network.AWS.ElastiCache.DeleteReplicationGroup" "amazonka-elasticache-1.4.5-DCZ22LKkzpiJjmUycYjUf" False) (C1 (MetaCons "DeleteReplicationGroupResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_delrsReplicationGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ReplicationGroup))) (S1 (MetaSel (Just Symbol "_delrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

delrsReplicationGroup :: Lens' DeleteReplicationGroupResponse (Maybe ReplicationGroup)

Undocumented member.

delrsResponseStatus :: Lens' DeleteReplicationGroupResponse Int

• - | The response status code.