amazonka-rds-1.4.5: Amazon Relational Database Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.RDS.RebootDBInstance

Contents

Description

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

Synopsis

Creating a Request

rebootDBInstance #

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

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

  • rdiForceFailover - When true , the reboot will be conducted through a MultiAZ failover. Constraint: You cannot specify true if the instance is not configured for MultiAZ.
  • rdiDBInstanceIdentifier - The DB instance identifier. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens

data RebootDBInstance #

See: rebootDBInstance smart constructor.

Instances

Eq RebootDBInstance # 
Data RebootDBInstance # 

Methods

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

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

toConstr :: RebootDBInstance -> Constr #

dataTypeOf :: RebootDBInstance -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> RebootDBInstance -> RebootDBInstance #

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

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

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

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

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

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

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

Read RebootDBInstance # 
Show RebootDBInstance # 
Generic RebootDBInstance # 
Hashable RebootDBInstance # 
NFData RebootDBInstance # 

Methods

rnf :: RebootDBInstance -> () #

AWSRequest RebootDBInstance # 
ToQuery RebootDBInstance # 
ToPath RebootDBInstance # 
ToHeaders RebootDBInstance # 
type Rep RebootDBInstance # 
type Rep RebootDBInstance = D1 (MetaData "RebootDBInstance" "Network.AWS.RDS.RebootDBInstance" "amazonka-rds-1.4.5-I79yxZdjKNFFGn6ti49zKn" False) (C1 (MetaCons "RebootDBInstance'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rdiForceFailover") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_rdiDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs RebootDBInstance # 

Request Lenses

rdiForceFailover :: Lens' RebootDBInstance (Maybe Bool) #

When true , the reboot will be conducted through a MultiAZ failover. Constraint: You cannot specify true if the instance is not configured for MultiAZ.

rdiDBInstanceIdentifier :: Lens' RebootDBInstance Text #

The DB instance identifier. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 alphanumeric characters or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens

Destructuring the Response

rebootDBInstanceResponse #

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

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

data RebootDBInstanceResponse #

See: rebootDBInstanceResponse smart constructor.

Instances

Eq RebootDBInstanceResponse # 
Data RebootDBInstanceResponse # 

Methods

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

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

toConstr :: RebootDBInstanceResponse -> Constr #

dataTypeOf :: RebootDBInstanceResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> RebootDBInstanceResponse -> RebootDBInstanceResponse #

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

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

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

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

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

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

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

Read RebootDBInstanceResponse # 
Show RebootDBInstanceResponse # 
Generic RebootDBInstanceResponse # 
NFData RebootDBInstanceResponse # 
type Rep RebootDBInstanceResponse # 
type Rep RebootDBInstanceResponse = D1 (MetaData "RebootDBInstanceResponse" "Network.AWS.RDS.RebootDBInstance" "amazonka-rds-1.4.5-I79yxZdjKNFFGn6ti49zKn" False) (C1 (MetaCons "RebootDBInstanceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rdirsDBInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBInstance))) (S1 (MetaSel (Just Symbol "_rdirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

rdirsResponseStatus :: Lens' RebootDBInstanceResponse Int #

  • - | The response status code.