Copyright | (c) 2013-2021 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 |
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.
This action only restores the DB cluster, not the DB instances for that
DB cluster. You must invoke the CreateDBInstance action to create DB
instances for the restored DB cluster, specifying the identifier of the
restored DB cluster in DBClusterIdentifier
. You can create DB
instances only after the RestoreDBClusterToPointInTime
action has
completed and the DB cluster is available.
Synopsis
- data RestoreDBClusterToPointInTime = RestoreDBClusterToPointInTime' {
- deletionProtection :: Maybe Bool
- useLatestRestorableTime :: Maybe Bool
- dbSubnetGroupName :: Maybe Text
- kmsKeyId :: Maybe Text
- vpcSecurityGroupIds :: Maybe [Text]
- dbClusterParameterGroupName :: Maybe Text
- restoreType :: Maybe Text
- optionGroupName :: Maybe Text
- restoreToTime :: Maybe ISO8601
- tags :: Maybe [Tag]
- port :: Maybe Int
- enableIAMDatabaseAuthentication :: Maybe Bool
- enableCloudwatchLogsExports :: Maybe [Text]
- dbClusterIdentifier :: Text
- sourceDBClusterIdentifier :: Text
- newRestoreDBClusterToPointInTime :: Text -> Text -> RestoreDBClusterToPointInTime
- restoreDBClusterToPointInTime_deletionProtection :: Lens' RestoreDBClusterToPointInTime (Maybe Bool)
- restoreDBClusterToPointInTime_useLatestRestorableTime :: Lens' RestoreDBClusterToPointInTime (Maybe Bool)
- restoreDBClusterToPointInTime_dbSubnetGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- restoreDBClusterToPointInTime_kmsKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- restoreDBClusterToPointInTime_vpcSecurityGroupIds :: Lens' RestoreDBClusterToPointInTime (Maybe [Text])
- restoreDBClusterToPointInTime_dbClusterParameterGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- restoreDBClusterToPointInTime_restoreType :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- restoreDBClusterToPointInTime_optionGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text)
- restoreDBClusterToPointInTime_restoreToTime :: Lens' RestoreDBClusterToPointInTime (Maybe UTCTime)
- restoreDBClusterToPointInTime_tags :: Lens' RestoreDBClusterToPointInTime (Maybe [Tag])
- restoreDBClusterToPointInTime_port :: Lens' RestoreDBClusterToPointInTime (Maybe Int)
- restoreDBClusterToPointInTime_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterToPointInTime (Maybe Bool)
- restoreDBClusterToPointInTime_enableCloudwatchLogsExports :: Lens' RestoreDBClusterToPointInTime (Maybe [Text])
- restoreDBClusterToPointInTime_dbClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text
- restoreDBClusterToPointInTime_sourceDBClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text
- data RestoreDBClusterToPointInTimeResponse = RestoreDBClusterToPointInTimeResponse' {
- dbCluster :: Maybe DBCluster
- httpStatus :: Int
- newRestoreDBClusterToPointInTimeResponse :: Int -> RestoreDBClusterToPointInTimeResponse
- restoreDBClusterToPointInTimeResponse_dbCluster :: Lens' RestoreDBClusterToPointInTimeResponse (Maybe DBCluster)
- restoreDBClusterToPointInTimeResponse_httpStatus :: Lens' RestoreDBClusterToPointInTimeResponse Int
Creating a Request
data RestoreDBClusterToPointInTime Source #
See: newRestoreDBClusterToPointInTime
smart constructor.
RestoreDBClusterToPointInTime' | |
|
Instances
newRestoreDBClusterToPointInTime Source #
:: Text | |
-> Text |
|
-> RestoreDBClusterToPointInTime |
Create a value of RestoreDBClusterToPointInTime
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:deletionProtection:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_deletionProtection
- A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
$sel:useLatestRestorableTime:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_useLatestRestorableTime
- 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.
$sel:dbSubnetGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbSubnetGroupName
- 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
$sel:kmsKeyId:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_kmsKeyId
- The Amazon 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 Amazon 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.
$sel:vpcSecurityGroupIds:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster belongs to.
$sel:dbClusterParameterGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with the new DB
cluster.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
$sel:restoreType:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_restoreType
- 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.
If you don't specify a RestoreType
value, then the new DB cluster is
restored as a full copy of the source DB cluster.
$sel:optionGroupName:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_optionGroupName
- (Not supported by Neptune)
$sel:restoreToTime:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_restoreToTime
- 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 iscopy-on-write
Example: 2015-03-07T23:45:00Z
$sel:tags:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_tags
- The tags to be applied to the restored DB cluster.
$sel:port:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_port
- 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.
$sel:enableIAMDatabaseAuthentication:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_enableIAMDatabaseAuthentication
- True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
Default: false
$sel:enableCloudwatchLogsExports:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to CloudWatch
Logs.
$sel:dbClusterIdentifier:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_dbClusterIdentifier
- 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
$sel:sourceDBClusterIdentifier:RestoreDBClusterToPointInTime'
, restoreDBClusterToPointInTime_sourceDBClusterIdentifier
- The identifier of the source DB cluster from which to restore.
Constraints:
- Must match the identifier of an existing DBCluster.
Request Lenses
restoreDBClusterToPointInTime_deletionProtection :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
restoreDBClusterToPointInTime_useLatestRestorableTime :: 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.
restoreDBClusterToPointInTime_dbSubnetGroupName :: 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
restoreDBClusterToPointInTime_kmsKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #
The Amazon 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 Amazon 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.
restoreDBClusterToPointInTime_vpcSecurityGroupIds :: Lens' RestoreDBClusterToPointInTime (Maybe [Text]) Source #
A list of VPC security groups that the new DB cluster belongs to.
restoreDBClusterToPointInTime_dbClusterParameterGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #
The name of the DB cluster parameter group to associate with the new DB cluster.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
restoreDBClusterToPointInTime_restoreType :: 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.
If you don't specify a RestoreType
value, then the new DB cluster is
restored as a full copy of the source DB cluster.
restoreDBClusterToPointInTime_optionGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #
(Not supported by Neptune)
restoreDBClusterToPointInTime_restoreToTime :: 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 iscopy-on-write
Example: 2015-03-07T23:45:00Z
restoreDBClusterToPointInTime_tags :: Lens' RestoreDBClusterToPointInTime (Maybe [Tag]) Source #
The tags to be applied to the restored DB cluster.
restoreDBClusterToPointInTime_port :: 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.
restoreDBClusterToPointInTime_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
restoreDBClusterToPointInTime_enableCloudwatchLogsExports :: Lens' RestoreDBClusterToPointInTime (Maybe [Text]) Source #
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
restoreDBClusterToPointInTime_dbClusterIdentifier :: 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
restoreDBClusterToPointInTime_sourceDBClusterIdentifier :: 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
data RestoreDBClusterToPointInTimeResponse Source #
See: newRestoreDBClusterToPointInTimeResponse
smart constructor.
RestoreDBClusterToPointInTimeResponse' | |
|
Instances
newRestoreDBClusterToPointInTimeResponse Source #
Create a value of RestoreDBClusterToPointInTimeResponse
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:dbCluster:RestoreDBClusterToPointInTimeResponse'
, restoreDBClusterToPointInTimeResponse_dbCluster
- Undocumented member.
$sel:httpStatus:RestoreDBClusterToPointInTimeResponse'
, restoreDBClusterToPointInTimeResponse_httpStatus
- The response's http status code.
Response Lenses
restoreDBClusterToPointInTimeResponse_dbCluster :: Lens' RestoreDBClusterToPointInTimeResponse (Maybe DBCluster) Source #
Undocumented member.
restoreDBClusterToPointInTimeResponse_httpStatus :: Lens' RestoreDBClusterToPointInTimeResponse Int Source #
The response's http status code.