Network.AWS.RDS.BacktrackDBCluster

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon RDS User Guide.

Creating a Request

backtrackDBCluster

Arguments

:: Text

bdcDBClusterIdentifier

-> UTCTime

bdcBacktrackTo

-> BacktrackDBCluster

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

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

• bdcForce - A value that, if specified, forces the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
• bdcUseEarliestTimeOnPointInTimeUnavailable - If BacktrackTo is set to a timestamp earlier than the earliest backtrack time, this value backtracks the DB cluster to the earliest possible backtrack time. Otherwise, an error occurs.
• bdcDBClusterIdentifier - The DB cluster identifier of the DB cluster to be backtracked. 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. Example: my-cluster1
• bdcBacktrackTo - The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page. Constraints: * Must contain a valid ISO 8601 timestamp. * Cannot contain a timestamp set in the future. Example: 2017-07-08T18:00Z

data BacktrackDBCluster

See: backtrackDBCluster smart constructor.

Instances

Eq BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

(==) :: BacktrackDBCluster -> BacktrackDBCluster -> Bool

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

Data BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

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

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

toConstr :: BacktrackDBCluster -> Constr

dataTypeOf :: BacktrackDBCluster -> DataType

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

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

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

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

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

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

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

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

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

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

Read BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

readsPrec :: Int -> ReadS BacktrackDBCluster

readList :: ReadS [BacktrackDBCluster]

readPrec :: ReadPrec BacktrackDBCluster

readListPrec :: ReadPrec [BacktrackDBCluster]

Show BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

showsPrec :: Int -> BacktrackDBCluster -> ShowS

show :: BacktrackDBCluster -> String

showList :: [BacktrackDBCluster] -> ShowS

Generic BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Associated Types

type Rep BacktrackDBCluster :: Type -> Type

Methods

from :: BacktrackDBCluster -> Rep BacktrackDBCluster x

to :: Rep BacktrackDBCluster x -> BacktrackDBCluster

Hashable BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

hashWithSalt :: Int -> BacktrackDBCluster -> Int

hash :: BacktrackDBCluster -> Int

AWSRequest BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Associated Types

type Rs BacktrackDBCluster :: Type

Methods

request :: BacktrackDBCluster -> Request BacktrackDBCluster

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

ToHeaders BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

toHeaders :: BacktrackDBCluster -> [Header]

ToPath BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

toPath :: BacktrackDBCluster -> ByteString

ToQuery BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

toQuery :: BacktrackDBCluster -> QueryString

NFData BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

Methods

rnf :: BacktrackDBCluster -> ()

type Rep BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

type Rep BacktrackDBCluster = D1 (MetaData "BacktrackDBCluster" "Network.AWS.RDS.BacktrackDBCluster" "amazonka-rds-1.6.1-GvYb6r2di9RGFKQcoJXq1A" False) (C1 (MetaCons "BacktrackDBCluster'" PrefixI True) ((S1 (MetaSel (Just "_bdcForce") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_bdcUseEarliestTimeOnPointInTimeUnavailable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_bdcDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_bdcBacktrackTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ISO8601))))

type Rs BacktrackDBCluster

Defined in Network.AWS.RDS.BacktrackDBCluster

type Rs BacktrackDBCluster = DBClusterBacktrack

Request Lenses

bdcForce :: Lens' BacktrackDBCluster (Maybe Bool)

A value that, if specified, forces the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

bdcUseEarliestTimeOnPointInTimeUnavailable :: Lens' BacktrackDBCluster (Maybe Bool)

If BacktrackTo is set to a timestamp earlier than the earliest backtrack time, this value backtracks the DB cluster to the earliest possible backtrack time. Otherwise, an error occurs.

bdcDBClusterIdentifier :: Lens' BacktrackDBCluster Text

The DB cluster identifier of the DB cluster to be backtracked. 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. Example: my-cluster1

bdcBacktrackTo :: Lens' BacktrackDBCluster UTCTime

The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page. Constraints: * Must contain a valid ISO 8601 timestamp. * Cannot contain a timestamp set in the future. Example: 2017-07-08T18:00Z

Destructuring the Response

dbClusterBacktrack :: DBClusterBacktrack

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

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

• dcbStatus - The status of the backtrack. This property returns one of the following values: * applying - The backtrack is currently being applied to or rolled back from the DB cluster. * completed - The backtrack has successfully been applied to or rolled back from the DB cluster. * failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster. * pending - The backtrack is currently pending application to or rollback from the DB cluster.
• dcbBacktrackIdentifier - Contains the backtrack identifier.
• dcbBacktrackTo - The timestamp of the time to which the DB cluster was backtracked.
• dcbDBClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
• dcbBacktrackedFrom - The timestamp of the time from which the DB cluster was backtracked.
• dcbBacktrackRequestCreationTime - The timestamp of the time at which the backtrack was requested.

data DBClusterBacktrack

This data type is used as a response element in the DescribeDBClusterBacktracks action.

See: dbClusterBacktrack smart constructor.

Instances

Eq DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

Methods

(==) :: DBClusterBacktrack -> DBClusterBacktrack -> Bool

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

Data DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

Methods

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

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

toConstr :: DBClusterBacktrack -> Constr

dataTypeOf :: DBClusterBacktrack -> DataType

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

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

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

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

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

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

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

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

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

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

Read DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

Methods

readsPrec :: Int -> ReadS DBClusterBacktrack

readList :: ReadS [DBClusterBacktrack]

readPrec :: ReadPrec DBClusterBacktrack

readListPrec :: ReadPrec [DBClusterBacktrack]

Show DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

Methods

showsPrec :: Int -> DBClusterBacktrack -> ShowS

show :: DBClusterBacktrack -> String

showList :: [DBClusterBacktrack] -> ShowS

Generic DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

Associated Types

type Rep DBClusterBacktrack :: Type -> Type

Methods

from :: DBClusterBacktrack -> Rep DBClusterBacktrack x

to :: Rep DBClusterBacktrack x -> DBClusterBacktrack

Hashable DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

Methods

hashWithSalt :: Int -> DBClusterBacktrack -> Int

hash :: DBClusterBacktrack -> Int

FromXML DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

Methods

parseXML :: [Node] -> Either String DBClusterBacktrack

NFData DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

Methods

rnf :: DBClusterBacktrack -> ()

type Rep DBClusterBacktrack

Defined in Network.AWS.RDS.Types.Product

type Rep DBClusterBacktrack = D1 (MetaData "DBClusterBacktrack" "Network.AWS.RDS.Types.Product" "amazonka-rds-1.6.1-GvYb6r2di9RGFKQcoJXq1A" False) (C1 (MetaCons "DBClusterBacktrack'" PrefixI True) ((S1 (MetaSel (Just "_dcbStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dcbBacktrackIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dcbBacktrackTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: (S1 (MetaSel (Just "_dcbDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dcbBacktrackedFrom") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 (MetaSel (Just "_dcbBacktrackRequestCreationTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))))))

Response Lenses

dcbStatus :: Lens' DBClusterBacktrack (Maybe Text)

The status of the backtrack. This property returns one of the following values: * applying - The backtrack is currently being applied to or rolled back from the DB cluster. * completed - The backtrack has successfully been applied to or rolled back from the DB cluster. * failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster. * pending - The backtrack is currently pending application to or rollback from the DB cluster.

dcbBacktrackIdentifier :: Lens' DBClusterBacktrack (Maybe Text)

Contains the backtrack identifier.

dcbBacktrackTo :: Lens' DBClusterBacktrack (Maybe UTCTime)

The timestamp of the time to which the DB cluster was backtracked.

dcbDBClusterIdentifier :: Lens' DBClusterBacktrack (Maybe Text)

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

dcbBacktrackedFrom :: Lens' DBClusterBacktrack (Maybe UTCTime)

The timestamp of the time from which the DB cluster was backtracked.

dcbBacktrackRequestCreationTime :: Lens' DBClusterBacktrack (Maybe UTCTime)

The timestamp of the time at which the backtrack was requested.