Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.BacktrackDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 Aurora User Guide.

This action applies only to Aurora MySQL DB clusters.

Synopsis

data BacktrackDBCluster = BacktrackDBCluster' {
- force :: Maybe Bool
- useEarliestTimeOnPointInTimeUnavailable :: Maybe Bool
- dbClusterIdentifier :: Text
- backtrackTo :: ISO8601
}
newBacktrackDBCluster :: Text -> UTCTime -> BacktrackDBCluster
backtrackDBCluster_force :: Lens' BacktrackDBCluster (Maybe Bool)
backtrackDBCluster_useEarliestTimeOnPointInTimeUnavailable :: Lens' BacktrackDBCluster (Maybe Bool)
backtrackDBCluster_dbClusterIdentifier :: Lens' BacktrackDBCluster Text
backtrackDBCluster_backtrackTo :: Lens' BacktrackDBCluster UTCTime
data DBClusterBacktrack = DBClusterBacktrack' {
- backtrackIdentifier :: Maybe Text
- backtrackRequestCreationTime :: Maybe ISO8601
- backtrackTo :: Maybe ISO8601
- backtrackedFrom :: Maybe ISO8601
- dbClusterIdentifier :: Maybe Text
- status :: Maybe Text
}
newDBClusterBacktrack :: DBClusterBacktrack
dbClusterBacktrack_backtrackIdentifier :: Lens' DBClusterBacktrack (Maybe Text)
dbClusterBacktrack_backtrackRequestCreationTime :: Lens' DBClusterBacktrack (Maybe UTCTime)
dbClusterBacktrack_backtrackTo :: Lens' DBClusterBacktrack (Maybe UTCTime)
dbClusterBacktrack_backtrackedFrom :: Lens' DBClusterBacktrack (Maybe UTCTime)
dbClusterBacktrack_dbClusterIdentifier :: Lens' DBClusterBacktrack (Maybe Text)
dbClusterBacktrack_status :: Lens' DBClusterBacktrack (Maybe Text)

Creating a Request

data BacktrackDBCluster Source #

See: newBacktrackDBCluster smart constructor.

Constructors

BacktrackDBCluster'

Fields

force :: Maybe Bool
A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
useEarliestTimeOnPointInTimeUnavailable :: Maybe Bool
A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
dbClusterIdentifier :: 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.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
backtrackTo :: ISO8601
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.
If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:
- Must contain a valid ISO 8601 timestamp.
- Can't contain a timestamp set in the future.
Example: 2017-07-08T18:00Z

Instances

Instances details

ToHeaders BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Methods toHeaders :: BacktrackDBCluster -> [Header] #
ToPath BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Methods toPath :: BacktrackDBCluster -> ByteString #
ToQuery BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Methods toQuery :: BacktrackDBCluster -> QueryString #
AWSRequest BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Associated Types type AWSResponse BacktrackDBCluster # Methods request :: (Service -> Service) -> BacktrackDBCluster -> Request BacktrackDBCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BacktrackDBCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BacktrackDBCluster))) #
Generic BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Associated Types type Rep BacktrackDBCluster :: Type -> Type # Methods from :: BacktrackDBCluster -> Rep BacktrackDBCluster x # to :: Rep BacktrackDBCluster x -> BacktrackDBCluster #
Read BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Methods readsPrec :: Int -> ReadS BacktrackDBCluster # readList :: ReadS [BacktrackDBCluster] # readPrec :: ReadPrec BacktrackDBCluster # readListPrec :: ReadPrec [BacktrackDBCluster] #
Show BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Methods showsPrec :: Int -> BacktrackDBCluster -> ShowS # show :: BacktrackDBCluster -> String # showList :: [BacktrackDBCluster] -> ShowS #
NFData BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Methods rnf :: BacktrackDBCluster -> () #
Eq BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Methods (==) :: BacktrackDBCluster -> BacktrackDBCluster -> Bool # (/=) :: BacktrackDBCluster -> BacktrackDBCluster -> Bool #
Hashable BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster Methods hashWithSalt :: Int -> BacktrackDBCluster -> Int # hash :: BacktrackDBCluster -> Int #
type AWSResponse BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster type AWSResponse BacktrackDBCluster = DBClusterBacktrack
type Rep BacktrackDBCluster Source #
Instance details Defined in Amazonka.RDS.BacktrackDBCluster type Rep BacktrackDBCluster = D1 ('MetaData "BacktrackDBCluster" "Amazonka.RDS.BacktrackDBCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "BacktrackDBCluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "force") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "useEarliestTimeOnPointInTimeUnavailable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "backtrackTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))

newBacktrackDBCluster Source #

Arguments

:: Text	`BacktrackDBCluster`
-> UTCTime	`BacktrackDBCluster`
-> BacktrackDBCluster

Create a value of BacktrackDBCluster 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:force:BacktrackDBCluster', backtrackDBCluster_force - A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

$sel:useEarliestTimeOnPointInTimeUnavailable:BacktrackDBCluster', backtrackDBCluster_useEarliestTimeOnPointInTimeUnavailable - A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

BacktrackDBCluster, backtrackDBCluster_dbClusterIdentifier - 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.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

BacktrackDBCluster, backtrackDBCluster_backtrackTo - 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.

If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

Constraints:

Must contain a valid ISO 8601 timestamp.
Can't contain a timestamp set in the future.

Example: 2017-07-08T18:00Z

Request Lenses

backtrackDBCluster_force :: Lens' BacktrackDBCluster (Maybe Bool) Source #

A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

backtrackDBCluster_useEarliestTimeOnPointInTimeUnavailable :: Lens' BacktrackDBCluster (Maybe Bool) Source #

A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

backtrackDBCluster_dbClusterIdentifier :: Lens' BacktrackDBCluster Text Source #

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.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

backtrackDBCluster_backtrackTo :: Lens' BacktrackDBCluster UTCTime Source #

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.

If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

Constraints:

Must contain a valid ISO 8601 timestamp.
Can't contain a timestamp set in the future.

Example: 2017-07-08T18:00Z

Destructuring the Response

data DBClusterBacktrack Source #

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

See: newDBClusterBacktrack smart constructor.

Constructors

DBClusterBacktrack'

Fields

backtrackIdentifier :: Maybe Text
Contains the backtrack identifier.
backtrackRequestCreationTime :: Maybe ISO8601
The timestamp of the time at which the backtrack was requested.
backtrackTo :: Maybe ISO8601
The timestamp of the time to which the DB cluster was backtracked.
backtrackedFrom :: Maybe ISO8601
The timestamp of the time from which the DB cluster was backtracked.
dbClusterIdentifier :: Maybe Text
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
status :: 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.

Instances

Instances details

FromXML DBClusterBacktrack Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterBacktrack Methods parseXML :: [Node] -> Either String DBClusterBacktrack #
Generic DBClusterBacktrack Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterBacktrack Associated Types type Rep DBClusterBacktrack :: Type -> Type # Methods from :: DBClusterBacktrack -> Rep DBClusterBacktrack x # to :: Rep DBClusterBacktrack x -> DBClusterBacktrack #
Read DBClusterBacktrack Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterBacktrack Methods readsPrec :: Int -> ReadS DBClusterBacktrack # readList :: ReadS [DBClusterBacktrack] # readPrec :: ReadPrec DBClusterBacktrack # readListPrec :: ReadPrec [DBClusterBacktrack] #
Show DBClusterBacktrack Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterBacktrack Methods showsPrec :: Int -> DBClusterBacktrack -> ShowS # show :: DBClusterBacktrack -> String # showList :: [DBClusterBacktrack] -> ShowS #
NFData DBClusterBacktrack Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterBacktrack Methods rnf :: DBClusterBacktrack -> () #
Eq DBClusterBacktrack Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterBacktrack Methods (==) :: DBClusterBacktrack -> DBClusterBacktrack -> Bool # (/=) :: DBClusterBacktrack -> DBClusterBacktrack -> Bool #
Hashable DBClusterBacktrack Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterBacktrack Methods hashWithSalt :: Int -> DBClusterBacktrack -> Int # hash :: DBClusterBacktrack -> Int #
type Rep DBClusterBacktrack Source #
Instance details Defined in Amazonka.RDS.Types.DBClusterBacktrack type Rep DBClusterBacktrack = D1 ('MetaData "DBClusterBacktrack" "Amazonka.RDS.Types.DBClusterBacktrack" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterBacktrack'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backtrackIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "backtrackRequestCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "backtrackTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: (S1 ('MetaSel ('Just "backtrackedFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDBClusterBacktrack :: DBClusterBacktrack Source #

Create a value of DBClusterBacktrack 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:backtrackIdentifier:DBClusterBacktrack', dbClusterBacktrack_backtrackIdentifier - Contains the backtrack identifier.

$sel:backtrackRequestCreationTime:DBClusterBacktrack', dbClusterBacktrack_backtrackRequestCreationTime - The timestamp of the time at which the backtrack was requested.

$sel:backtrackTo:DBClusterBacktrack', dbClusterBacktrack_backtrackTo - The timestamp of the time to which the DB cluster was backtracked.

$sel:backtrackedFrom:DBClusterBacktrack', dbClusterBacktrack_backtrackedFrom - The timestamp of the time from which the DB cluster was backtracked.

$sel:dbClusterIdentifier:DBClusterBacktrack', dbClusterBacktrack_dbClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

$sel:status:DBClusterBacktrack', dbClusterBacktrack_status - 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.

Response Lenses

dbClusterBacktrack_backtrackIdentifier :: Lens' DBClusterBacktrack (Maybe Text) Source #

Contains the backtrack identifier.

dbClusterBacktrack_backtrackRequestCreationTime :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

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

dbClusterBacktrack_backtrackTo :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

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

dbClusterBacktrack_backtrackedFrom :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

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

dbClusterBacktrack_dbClusterIdentifier :: Lens' DBClusterBacktrack (Maybe Text) Source #

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

dbClusterBacktrack_status :: Lens' DBClusterBacktrack (Maybe Text) Source #

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.