Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.ElastiCache.DeleteCacheCluster

Contents

Description

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group.

Important: Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.

Creating a Request

deleteCacheCluster Source #

Arguments

:: Text	`dccCacheClusterId`
-> DeleteCacheCluster

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

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

dccFinalSnapshotIdentifier - The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
dccCacheClusterId - The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

data DeleteCacheCluster Source #

Represents the input of a DeleteCacheCluster operation.

See: deleteCacheCluster smart constructor.

Instances

Eq DeleteCacheCluster Source #
Methods (==) :: DeleteCacheCluster -> DeleteCacheCluster -> Bool # (/=) :: DeleteCacheCluster -> DeleteCacheCluster -> Bool #
Data DeleteCacheCluster Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteCacheCluster -> c DeleteCacheCluster # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteCacheCluster # toConstr :: DeleteCacheCluster -> Constr # dataTypeOf :: DeleteCacheCluster -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteCacheCluster) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteCacheCluster) # gmapT :: (forall b. Data b => b -> b) -> DeleteCacheCluster -> DeleteCacheCluster # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteCacheCluster -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteCacheCluster -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteCacheCluster -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteCacheCluster -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteCacheCluster -> m DeleteCacheCluster # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteCacheCluster -> m DeleteCacheCluster # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteCacheCluster -> m DeleteCacheCluster #
Read DeleteCacheCluster Source #
Methods readsPrec :: Int -> ReadS DeleteCacheCluster # readList :: ReadS [DeleteCacheCluster] # readPrec :: ReadPrec DeleteCacheCluster # readListPrec :: ReadPrec [DeleteCacheCluster] #
Show DeleteCacheCluster Source #
Methods showsPrec :: Int -> DeleteCacheCluster -> ShowS # show :: DeleteCacheCluster -> String # showList :: [DeleteCacheCluster] -> ShowS #
Generic DeleteCacheCluster Source #
Associated Types type Rep DeleteCacheCluster :: * -> * # Methods from :: DeleteCacheCluster -> Rep DeleteCacheCluster x # to :: Rep DeleteCacheCluster x -> DeleteCacheCluster #
Hashable DeleteCacheCluster Source #
Methods hashWithSalt :: Int -> DeleteCacheCluster -> Int # hash :: DeleteCacheCluster -> Int #
NFData DeleteCacheCluster Source #
Methods rnf :: DeleteCacheCluster -> () #
AWSRequest DeleteCacheCluster Source #
Associated Types type Rs DeleteCacheCluster :: * # Methods request :: DeleteCacheCluster -> Request DeleteCacheCluster # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DeleteCacheCluster -> ClientResponse -> m (Response DeleteCacheCluster) #
ToHeaders DeleteCacheCluster Source #
Methods toHeaders :: DeleteCacheCluster -> [Header] #
ToPath DeleteCacheCluster Source #
Methods toPath :: DeleteCacheCluster -> ByteString #
ToQuery DeleteCacheCluster Source #
Methods toQuery :: DeleteCacheCluster -> QueryString #
type Rep DeleteCacheCluster Source #
type Rep DeleteCacheCluster = D1 * (MetaData "DeleteCacheCluster" "Network.AWS.ElastiCache.DeleteCacheCluster" "amazonka-elasticache-1.6.0-4uuZWL7zhxxEXFvtkJRku9" False) (C1 * (MetaCons "DeleteCacheCluster'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_dccFinalSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dccCacheClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))
type Rs DeleteCacheCluster Source #
type Rs DeleteCacheCluster = DeleteCacheClusterResponse

Request Lenses

dccFinalSnapshotIdentifier :: Lens' DeleteCacheCluster (Maybe Text) Source #

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

dccCacheClusterId :: Lens' DeleteCacheCluster Text Source #

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

Destructuring the Response

deleteCacheClusterResponse Source #

Arguments

:: Int	`dccrsResponseStatus`
-> DeleteCacheClusterResponse

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

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

dccrsCacheCluster - Undocumented member.
dccrsResponseStatus - -- | The response status code.

data DeleteCacheClusterResponse Source #

See: deleteCacheClusterResponse smart constructor.

Instances

Eq DeleteCacheClusterResponse Source #
Methods (==) :: DeleteCacheClusterResponse -> DeleteCacheClusterResponse -> Bool # (/=) :: DeleteCacheClusterResponse -> DeleteCacheClusterResponse -> Bool #
Data DeleteCacheClusterResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteCacheClusterResponse -> c DeleteCacheClusterResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteCacheClusterResponse # toConstr :: DeleteCacheClusterResponse -> Constr # dataTypeOf :: DeleteCacheClusterResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteCacheClusterResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteCacheClusterResponse) # gmapT :: (forall b. Data b => b -> b) -> DeleteCacheClusterResponse -> DeleteCacheClusterResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteCacheClusterResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteCacheClusterResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteCacheClusterResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteCacheClusterResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteCacheClusterResponse -> m DeleteCacheClusterResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteCacheClusterResponse -> m DeleteCacheClusterResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteCacheClusterResponse -> m DeleteCacheClusterResponse #
Read DeleteCacheClusterResponse Source #
Methods readsPrec :: Int -> ReadS DeleteCacheClusterResponse # readList :: ReadS [DeleteCacheClusterResponse] # readPrec :: ReadPrec DeleteCacheClusterResponse # readListPrec :: ReadPrec [DeleteCacheClusterResponse] #
Show DeleteCacheClusterResponse Source #
Methods showsPrec :: Int -> DeleteCacheClusterResponse -> ShowS # show :: DeleteCacheClusterResponse -> String # showList :: [DeleteCacheClusterResponse] -> ShowS #
Generic DeleteCacheClusterResponse Source #
Associated Types type Rep DeleteCacheClusterResponse :: * -> * # Methods from :: DeleteCacheClusterResponse -> Rep DeleteCacheClusterResponse x # to :: Rep DeleteCacheClusterResponse x -> DeleteCacheClusterResponse #
NFData DeleteCacheClusterResponse Source #
Methods rnf :: DeleteCacheClusterResponse -> () #
type Rep DeleteCacheClusterResponse Source #
type Rep DeleteCacheClusterResponse = D1 * (MetaData "DeleteCacheClusterResponse" "Network.AWS.ElastiCache.DeleteCacheCluster" "amazonka-elasticache-1.6.0-4uuZWL7zhxxEXFvtkJRku9" False) (C1 * (MetaCons "DeleteCacheClusterResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_dccrsCacheCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CacheCluster))) (S1 * (MetaSel (Just Symbol "_dccrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

dccrsCacheCluster :: Lens' DeleteCacheClusterResponse (Maybe CacheCluster) Source #

Undocumented member.

dccrsResponseStatus :: Lens' DeleteCacheClusterResponse Int Source #

- | The response status code.