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

Amazonka.RDS.RebootDBInstance

Description

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

Synopsis

Creating a Request

data RebootDBInstance Source #

See: newRebootDBInstance smart constructor.

Constructors

RebootDBInstance' 

Fields

  • forceFailover :: Maybe Bool

    A value that indicates whether the reboot is conducted through a Multi-AZ failover.

    Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

  • dbInstanceIdentifier :: Text

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

Instances

Instances details
Eq RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

(==) :: RebootDBInstance -> RebootDBInstance -> Bool #

(/=) :: RebootDBInstance -> RebootDBInstance -> Bool #

Read RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

readsPrec :: Int -> ReadS RebootDBInstance #

readList :: ReadS [RebootDBInstance] #

readPrec :: ReadPrec RebootDBInstance #

readListPrec :: ReadPrec [RebootDBInstance] #

Show RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

showsPrec :: Int -> RebootDBInstance -> ShowS #

show :: RebootDBInstance -> String #

showList :: [RebootDBInstance] -> ShowS #

Generic RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Associated Types

type Rep RebootDBInstance :: Type -> Type #

Methods

from :: RebootDBInstance -> Rep RebootDBInstance x #

to :: Rep RebootDBInstance x -> RebootDBInstance #

NFData RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

rnf :: RebootDBInstance -> () #

Hashable RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

hashWithSalt :: Int -> RebootDBInstance -> Int #

hash :: RebootDBInstance -> Int #

AWSRequest RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Associated Types

type AWSResponse RebootDBInstance #

Methods

request :: RebootDBInstance -> Request RebootDBInstance #

response :: MonadResource m => Logger -> Service -> Proxy RebootDBInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RebootDBInstance))) #

ToHeaders RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

toHeaders :: RebootDBInstance -> [Header] #

ToPath RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

toPath :: RebootDBInstance -> ByteString #

ToQuery RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

toQuery :: RebootDBInstance -> QueryString #

type Rep RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

type Rep RebootDBInstance = D1 ('MetaData "RebootDBInstance" "Amazonka.RDS.RebootDBInstance" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "RebootDBInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceFailover") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse RebootDBInstance Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

type AWSResponse RebootDBInstance = RebootDBInstanceResponse

newRebootDBInstance Source #

Arguments

:: Text

$sel:dbInstanceIdentifier:RebootDBInstance'

-> RebootDBInstance 

Create a value of RebootDBInstance 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:forceFailover:RebootDBInstance', rebootDBInstance_forceFailover - A value that indicates whether the reboot is conducted through a Multi-AZ failover.

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

$sel:dbInstanceIdentifier:RebootDBInstance', rebootDBInstance_dbInstanceIdentifier - The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Request Lenses

rebootDBInstance_forceFailover :: Lens' RebootDBInstance (Maybe Bool) Source #

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

rebootDBInstance_dbInstanceIdentifier :: Lens' RebootDBInstance Text Source #

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

Destructuring the Response

data RebootDBInstanceResponse Source #

See: newRebootDBInstanceResponse smart constructor.

Constructors

RebootDBInstanceResponse' 

Fields

Instances

Instances details
Eq RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

(==) :: RebootDBInstanceResponse -> RebootDBInstanceResponse -> Bool #

(/=) :: RebootDBInstanceResponse -> RebootDBInstanceResponse -> Bool #

Read RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

readsPrec :: Int -> ReadS RebootDBInstanceResponse #

readList :: ReadS [RebootDBInstanceResponse] #

readPrec :: ReadPrec RebootDBInstanceResponse #

readListPrec :: ReadPrec [RebootDBInstanceResponse] #

Show RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

showsPrec :: Int -> RebootDBInstanceResponse -> ShowS #

show :: RebootDBInstanceResponse -> String #

showList :: [RebootDBInstanceResponse] -> ShowS #

Generic RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Associated Types

type Rep RebootDBInstanceResponse :: Type -> Type #

Methods

from :: RebootDBInstanceResponse -> Rep RebootDBInstanceResponse x #

to :: Rep RebootDBInstanceResponse x -> RebootDBInstanceResponse #

NFData RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

Methods

rnf :: RebootDBInstanceResponse -> () #

type Rep RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.RebootDBInstance

type Rep RebootDBInstanceResponse = D1 ('MetaData "RebootDBInstanceResponse" "Amazonka.RDS.RebootDBInstance" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "RebootDBInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRebootDBInstanceResponse Source #

Arguments

:: Int

$sel:httpStatus:RebootDBInstanceResponse'

-> RebootDBInstanceResponse 

Create a value of RebootDBInstanceResponse 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:dbInstance:RebootDBInstanceResponse', rebootDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:RebootDBInstanceResponse', rebootDBInstanceResponse_httpStatus - The response's http status code.

Response Lenses

rebootDBInstanceResponse_dbInstance :: Lens' RebootDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

rebootDBInstanceResponse_httpStatus :: Lens' RebootDBInstanceResponse Int Source #

The response's http status code.