Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.ElastiCache.RebootCacheCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.

If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

Creating a Request

rebootCacheCluster #

Arguments

:: Text	`rccCacheClusterId`
-> RebootCacheCluster

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

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

rccCacheClusterId - The cluster identifier. This parameter is stored as a lowercase string.
rccCacheNodeIdsToReboot - A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

data RebootCacheCluster #

Represents the input of a RebootCacheCluster operation.

See: rebootCacheCluster smart constructor.

Instances

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

Request Lenses

rccCacheClusterId :: Lens' RebootCacheCluster Text #

The cluster identifier. This parameter is stored as a lowercase string.

rccCacheNodeIdsToReboot :: Lens' RebootCacheCluster [Text] #

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

Destructuring the Response

rebootCacheClusterResponse #

Arguments

:: Int	`rccrsResponseStatus`
-> RebootCacheClusterResponse

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

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

rccrsCacheCluster - Undocumented member.
rccrsResponseStatus - -- | The response status code.

data RebootCacheClusterResponse #

See: rebootCacheClusterResponse smart constructor.

Instances

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

Response Lenses

rccrsCacheCluster :: Lens' RebootCacheClusterResponse (Maybe CacheCluster) #

Undocumented member.

rccrsResponseStatus :: Lens' RebootCacheClusterResponse Int #

- | The response status code.