Network.AWS.RDS.StopDBInstance

Stops a DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.

Creating a Request

stopDBInstance

Arguments

:: Text

sdiDBInstanceIdentifier

-> StopDBInstance

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

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

• sdiDBSnapshotIdentifier - The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
• sdiDBInstanceIdentifier - The user-supplied instance identifier.

data StopDBInstance

See: stopDBInstance smart constructor.

Instances

Eq StopDBInstance

Methods

(==) :: StopDBInstance -> StopDBInstance -> Bool

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

Data StopDBInstance

Methods

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

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

toConstr :: StopDBInstance -> Constr

dataTypeOf :: StopDBInstance -> DataType

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

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

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

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

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

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

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

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

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

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

Read StopDBInstance

Methods

readsPrec :: Int -> ReadS StopDBInstance

readList :: ReadS [StopDBInstance]

readPrec :: ReadPrec StopDBInstance

readListPrec :: ReadPrec [StopDBInstance]

Show StopDBInstance

Methods

showsPrec :: Int -> StopDBInstance -> ShowS

show :: StopDBInstance -> String

showList :: [StopDBInstance] -> ShowS

Generic StopDBInstance

Associated Types

type Rep StopDBInstance :: * -> *

Methods

from :: StopDBInstance -> Rep StopDBInstance x

to :: Rep StopDBInstance x -> StopDBInstance

Hashable StopDBInstance

Methods

hashWithSalt :: Int -> StopDBInstance -> Int

hash :: StopDBInstance -> Int

NFData StopDBInstance

Methods

rnf :: StopDBInstance -> ()

AWSRequest StopDBInstance

Associated Types

type Rs StopDBInstance :: *

Methods

request :: StopDBInstance -> Request StopDBInstance

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * StopDBInstance -> ClientResponse -> m (Response StopDBInstance)

ToHeaders StopDBInstance

Methods

toHeaders :: StopDBInstance -> [Header]

ToPath StopDBInstance

Methods

toPath :: StopDBInstance -> ByteString

ToQuery StopDBInstance

Methods

toQuery :: StopDBInstance -> QueryString

type Rep StopDBInstance

type Rep StopDBInstance = D1 * (MetaData "StopDBInstance" "Network.AWS.RDS.StopDBInstance" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "StopDBInstance'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sdiDBSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sdiDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs StopDBInstance

type Rs StopDBInstance = StopDBInstanceResponse

Request Lenses

sdiDBSnapshotIdentifier :: Lens' StopDBInstance (Maybe Text)

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

sdiDBInstanceIdentifier :: Lens' StopDBInstance Text

The user-supplied instance identifier.

Destructuring the Response

stopDBInstanceResponse

Arguments

:: Int

sdirsResponseStatus

-> StopDBInstanceResponse

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

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

• sdirsDBInstance - Undocumented member.
• sdirsResponseStatus - -- | The response status code.

data StopDBInstanceResponse

See: stopDBInstanceResponse smart constructor.

Instances

Eq StopDBInstanceResponse

Methods

(==) :: StopDBInstanceResponse -> StopDBInstanceResponse -> Bool

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

Data StopDBInstanceResponse

Methods

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

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

toConstr :: StopDBInstanceResponse -> Constr

dataTypeOf :: StopDBInstanceResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read StopDBInstanceResponse

Methods

readsPrec :: Int -> ReadS StopDBInstanceResponse

readList :: ReadS [StopDBInstanceResponse]

readPrec :: ReadPrec StopDBInstanceResponse

readListPrec :: ReadPrec [StopDBInstanceResponse]

Show StopDBInstanceResponse

Methods

showsPrec :: Int -> StopDBInstanceResponse -> ShowS

show :: StopDBInstanceResponse -> String

showList :: [StopDBInstanceResponse] -> ShowS

Generic StopDBInstanceResponse

Associated Types

type Rep StopDBInstanceResponse :: * -> *

Methods

from :: StopDBInstanceResponse -> Rep StopDBInstanceResponse x

to :: Rep StopDBInstanceResponse x -> StopDBInstanceResponse

NFData StopDBInstanceResponse

Methods

rnf :: StopDBInstanceResponse -> ()

type Rep StopDBInstanceResponse

type Rep StopDBInstanceResponse = D1 * (MetaData "StopDBInstanceResponse" "Network.AWS.RDS.StopDBInstance" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "StopDBInstanceResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sdirsDBInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DBInstance))) (S1 * (MetaSel (Just Symbol "_sdirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

sdirsDBInstance :: Lens' StopDBInstanceResponse (Maybe DBInstance)

Undocumented member.

sdirsResponseStatus :: Lens' StopDBInstanceResponse Int

• - | The response status code.