Network.AWS.RDS.RestoreDBClusterToPointInTime

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Creating a Request

restoreDBClusterToPointInTime

Arguments

:: Text

rdctpitDBClusterIdentifier

-> Text

rdctpitSourceDBClusterIdentifier

-> RestoreDBClusterToPointInTime

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

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

• rdctpitUseLatestRestorableTime
• rdctpitDBSubnetGroupName
• rdctpitKMSKeyId
• rdctpitVPCSecurityGroupIds
• rdctpitOptionGroupName
• rdctpitRestoreToTime
• rdctpitTags
• rdctpitPort
• rdctpitDBClusterIdentifier
• rdctpitSourceDBClusterIdentifier

data RestoreDBClusterToPointInTime

See: restoreDBClusterToPointInTime smart constructor.

Instances

Eq RestoreDBClusterToPointInTime

Methods

(==) :: RestoreDBClusterToPointInTime -> RestoreDBClusterToPointInTime -> Bool

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

Data RestoreDBClusterToPointInTime

Methods

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

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

toConstr :: RestoreDBClusterToPointInTime -> Constr

dataTypeOf :: RestoreDBClusterToPointInTime -> DataType

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

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

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

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

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

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

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

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

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

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

Read RestoreDBClusterToPointInTime

Methods

readsPrec :: Int -> ReadS RestoreDBClusterToPointInTime

readList :: ReadS [RestoreDBClusterToPointInTime]

readPrec :: ReadPrec RestoreDBClusterToPointInTime

readListPrec :: ReadPrec [RestoreDBClusterToPointInTime]

Show RestoreDBClusterToPointInTime

Methods

showsPrec :: Int -> RestoreDBClusterToPointInTime -> ShowS

show :: RestoreDBClusterToPointInTime -> String

showList :: [RestoreDBClusterToPointInTime] -> ShowS

Generic RestoreDBClusterToPointInTime

Associated Types

type Rep RestoreDBClusterToPointInTime :: * -> *

Methods

from :: RestoreDBClusterToPointInTime -> Rep RestoreDBClusterToPointInTime x

to :: Rep RestoreDBClusterToPointInTime x -> RestoreDBClusterToPointInTime

Hashable RestoreDBClusterToPointInTime

Methods

hashWithSalt :: Int -> RestoreDBClusterToPointInTime -> Int

hash :: RestoreDBClusterToPointInTime -> Int

NFData RestoreDBClusterToPointInTime

Methods

rnf :: RestoreDBClusterToPointInTime -> ()

AWSRequest RestoreDBClusterToPointInTime

Associated Types

type Rs RestoreDBClusterToPointInTime :: *

Methods

request :: RestoreDBClusterToPointInTime -> Request RestoreDBClusterToPointInTime

response :: MonadResource m => Logger -> Service -> Proxy * RestoreDBClusterToPointInTime -> ClientResponse -> m (Response RestoreDBClusterToPointInTime)

ToPath RestoreDBClusterToPointInTime

Methods

toPath :: RestoreDBClusterToPointInTime -> ByteString

ToHeaders RestoreDBClusterToPointInTime

Methods

toHeaders :: RestoreDBClusterToPointInTime -> [Header]

ToQuery RestoreDBClusterToPointInTime

Methods

toQuery :: RestoreDBClusterToPointInTime -> QueryString

type Rep RestoreDBClusterToPointInTime

type Rep RestoreDBClusterToPointInTime = D1 (MetaData "RestoreDBClusterToPointInTime" "Network.AWS.RDS.RestoreDBClusterToPointInTime" "amazonka-rds-1.4.2-JgM977FTRAf6Z65uEqLG2D" False) (C1 (MetaCons "RestoreDBClusterToPointInTime'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdctpitUseLatestRestorableTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_rdctpitDBSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_rdctpitKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rdctpitVPCSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_rdctpitOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rdctpitRestoreToTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_rdctpitTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag])))) ((:*:) (S1 (MetaSel (Just Symbol "_rdctpitPort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_rdctpitDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rdctpitSourceDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs RestoreDBClusterToPointInTime

type Rs RestoreDBClusterToPointInTime = RestoreDBClusterToPointInTimeResponse

Request Lenses

rdctpitUseLatestRestorableTime :: Lens' RestoreDBClusterToPointInTime (Maybe Bool)

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

rdctpitDBSubnetGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text)

The DB subnet group name to use for the new DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

rdctpitKMSKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text)

The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.

rdctpitVPCSecurityGroupIds :: Lens' RestoreDBClusterToPointInTime [Text]

A lst of VPC security groups that the new DB cluster belongs to.

rdctpitOptionGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text)

The name of the option group for the new DB cluster.

rdctpitRestoreToTime :: Lens' RestoreDBClusterToPointInTime (Maybe UTCTime)

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

• Must be before the latest restorable time for the DB instance
• Cannot be specified if UseLatestRestorableTime parameter is true

Example: '2015-03-07T23:45:00Z'

rdctpitTags :: Lens' RestoreDBClusterToPointInTime [Tag]

Undocumented member.

rdctpitPort :: Lens' RestoreDBClusterToPointInTime (Maybe Int)

The port number on which the new DB cluster accepts connections.

Constraints: Value must be '1150-65535'

Default: The same port as the original DB cluster.

rdctpitDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text

The name of the new DB cluster to be created.

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

rdctpitSourceDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text

The identifier of the source DB cluster from which to restore.

Constraints:

• Must be the identifier of an existing database instance
• 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

restoreDBClusterToPointInTimeResponse

Arguments

:: Int

rdctpitrsResponseStatus

-> RestoreDBClusterToPointInTimeResponse

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

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

• rdctpitrsDBCluster
• rdctpitrsResponseStatus

data RestoreDBClusterToPointInTimeResponse

See: restoreDBClusterToPointInTimeResponse smart constructor.

Instances

Eq RestoreDBClusterToPointInTimeResponse

Methods

(==) :: RestoreDBClusterToPointInTimeResponse -> RestoreDBClusterToPointInTimeResponse -> Bool

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

Data RestoreDBClusterToPointInTimeResponse

Methods

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

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

toConstr :: RestoreDBClusterToPointInTimeResponse -> Constr

dataTypeOf :: RestoreDBClusterToPointInTimeResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read RestoreDBClusterToPointInTimeResponse

Methods

readsPrec :: Int -> ReadS RestoreDBClusterToPointInTimeResponse

readList :: ReadS [RestoreDBClusterToPointInTimeResponse]

readPrec :: ReadPrec RestoreDBClusterToPointInTimeResponse

readListPrec :: ReadPrec [RestoreDBClusterToPointInTimeResponse]

Show RestoreDBClusterToPointInTimeResponse

Methods

showsPrec :: Int -> RestoreDBClusterToPointInTimeResponse -> ShowS

show :: RestoreDBClusterToPointInTimeResponse -> String

showList :: [RestoreDBClusterToPointInTimeResponse] -> ShowS

Generic RestoreDBClusterToPointInTimeResponse

Associated Types

type Rep RestoreDBClusterToPointInTimeResponse :: * -> *

Methods

from :: RestoreDBClusterToPointInTimeResponse -> Rep RestoreDBClusterToPointInTimeResponse x

to :: Rep RestoreDBClusterToPointInTimeResponse x -> RestoreDBClusterToPointInTimeResponse

NFData RestoreDBClusterToPointInTimeResponse

Methods

rnf :: RestoreDBClusterToPointInTimeResponse -> ()

type Rep RestoreDBClusterToPointInTimeResponse

type Rep RestoreDBClusterToPointInTimeResponse = D1 (MetaData "RestoreDBClusterToPointInTimeResponse" "Network.AWS.RDS.RestoreDBClusterToPointInTime" "amazonka-rds-1.4.2-JgM977FTRAf6Z65uEqLG2D" False) (C1 (MetaCons "RestoreDBClusterToPointInTimeResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rdctpitrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBCluster))) (S1 (MetaSel (Just Symbol "_rdctpitrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

rdctpitrsDBCluster :: Lens' RestoreDBClusterToPointInTimeResponse (Maybe DBCluster)

Undocumented member.

rdctpitrsResponseStatus :: Lens' RestoreDBClusterToPointInTimeResponse Int

The response status code.