Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
Synopsis
- restoreDBClusterToPointInTime :: Text -> Text -> RestoreDBClusterToPointInTime
- data RestoreDBClusterToPointInTime
- rdctpitUseLatestRestorableTime :: Lens' RestoreDBClusterToPointInTime (Maybe Bool)
- rdctpitDBSubnetGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- rdctpitBacktrackWindow :: Lens' RestoreDBClusterToPointInTime (Maybe Integer)
- rdctpitKMSKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- rdctpitVPCSecurityGroupIds :: Lens' RestoreDBClusterToPointInTime [Text]
- rdctpitRestoreType :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- rdctpitOptionGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- rdctpitRestoreToTime :: Lens' RestoreDBClusterToPointInTime (Maybe UTCTime)
- rdctpitTags :: Lens' RestoreDBClusterToPointInTime [Tag]
- rdctpitPort :: Lens' RestoreDBClusterToPointInTime (Maybe Int)
- rdctpitEnableIAMDatabaseAuthentication :: Lens' RestoreDBClusterToPointInTime (Maybe Bool)
- rdctpitDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text
- rdctpitSourceDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text
- restoreDBClusterToPointInTimeResponse :: Int -> RestoreDBClusterToPointInTimeResponse
- data RestoreDBClusterToPointInTimeResponse
- rdctpitrsDBCluster :: Lens' RestoreDBClusterToPointInTimeResponse (Maybe DBCluster)
- rdctpitrsResponseStatus :: Lens' RestoreDBClusterToPointInTimeResponse Int
Creating a Request
restoreDBClusterToPointInTime Source #
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
- A value that is set totrue
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise. Default:false
Constraints: Cannot be specified ifRestoreToTime
parameter is provided.rdctpitDBSubnetGroupName
- The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example:mySubnetgroup
rdctpitBacktrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours).rdctpitKMSKeyId
- The AWS 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 is encrypted with the KMS key identified by theKmsKeyId
parameter. If you do not specify a value for theKmsKeyId
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. IfDBClusterIdentifier
refers to a DB cluster that is not encrypted, then the restore request is rejected.rdctpitVPCSecurityGroupIds
- A list of VPC security groups that the new DB cluster belongs to.rdctpitRestoreType
- The type of restore to be performed. You can specify one of the following values: *full-copy
- The new DB cluster is restored as a full copy of the source DB cluster. *copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can't specifycopy-on-write
if the engine version of the source DB cluster is earlier than 1.11. If you don't specify aRestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.rdctpitOptionGroupName
- The name of the option group for the new DB cluster.rdctpitRestoreToTime
- 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 * Must be specified ifUseLatestRestorableTime
parameter is not provided * Cannot be specified ifUseLatestRestorableTime
parameter is true * Cannot be specified ifRestoreType
parameter iscopy-on-write
Example:2015-03-07T23:45:00Z
rdctpitTags
- Undocumented member.rdctpitPort
- The port number on which the new DB cluster accepts connections. Constraints: Value must be1150-65535
Default: The same port as the original DB cluster.rdctpitEnableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default:false
rdctpitDBClusterIdentifier
- The name of the new DB cluster to be created. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphensrdctpitSourceDBClusterIdentifier
- The identifier of the source DB cluster from which to restore. Constraints: * Must match the identifier of an existing DBCluster.
data RestoreDBClusterToPointInTime Source #
See: restoreDBClusterToPointInTime
smart constructor.
Instances
Request Lenses
rdctpitUseLatestRestorableTime :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #
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) Source #
The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
rdctpitBacktrackWindow :: Lens' RestoreDBClusterToPointInTime (Maybe Integer) Source #
The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours).
rdctpitKMSKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #
The AWS 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 is 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 not encrypted, then the restore request is rejected.
rdctpitVPCSecurityGroupIds :: Lens' RestoreDBClusterToPointInTime [Text] Source #
A list of VPC security groups that the new DB cluster belongs to.
rdctpitRestoreType :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #
The type of restore to be performed. You can specify one of the following values: * full-copy
- The new DB cluster is restored as a full copy of the source DB cluster. * copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can't specify copy-on-write
if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a RestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.
rdctpitOptionGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #
The name of the option group for the new DB cluster.
rdctpitRestoreToTime :: Lens' RestoreDBClusterToPointInTime (Maybe UTCTime) Source #
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 * Must be specified if UseLatestRestorableTime
parameter is not provided * Cannot be specified if UseLatestRestorableTime
parameter is true * Cannot be specified if RestoreType
parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
rdctpitTags :: Lens' RestoreDBClusterToPointInTime [Tag] Source #
Undocumented member.
rdctpitPort :: Lens' RestoreDBClusterToPointInTime (Maybe Int) Source #
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.
rdctpitEnableIAMDatabaseAuthentication :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
rdctpitDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text Source #
The name of the new DB cluster to be created. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens
rdctpitSourceDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text Source #
The identifier of the source DB cluster from which to restore. Constraints: * Must match the identifier of an existing DBCluster.
Destructuring the Response
restoreDBClusterToPointInTimeResponse Source #
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
- Undocumented member.rdctpitrsResponseStatus
- -- | The response status code.
data RestoreDBClusterToPointInTimeResponse Source #
See: restoreDBClusterToPointInTimeResponse
smart constructor.
Instances
Response Lenses
rdctpitrsDBCluster :: Lens' RestoreDBClusterToPointInTimeResponse (Maybe DBCluster) Source #
Undocumented member.
rdctpitrsResponseStatus :: Lens' RestoreDBClusterToPointInTimeResponse Int Source #
- - | The response status code.