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.DocumentDB.RestoreDBClusterToPointInTime

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data RestoreDBClusterToPointInTime Source #

Represents the input to RestoreDBClusterToPointInTime.

See: newRestoreDBClusterToPointInTime smart constructor.

Constructors

RestoreDBClusterToPointInTime'

Fields

dbSubnetGroupName :: Maybe Text
The subnet group name to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
deletionProtection :: Maybe Bool
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
enableCloudwatchLogsExports :: Maybe [Text]
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
kmsKeyId :: Maybe Text
The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source 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 occurs:
- If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
- If the cluster is not encrypted, then the restored cluster is not encrypted.
If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.
port :: Maybe Int
The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150 to 65535.
Default: The default port for the engine.
restoreToTime :: Maybe ISO8601
The date and time to restore the cluster to.
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
- Must be before the latest restorable time for the instance.
- Must be specified if the UseLatestRestorableTime parameter is not provided.
- Cannot be specified if the UseLatestRestorableTime parameter is true.
- Cannot be specified if the RestoreType parameter is copy-on-write.
Example: 2015-03-07T23:45:00Z
restoreType :: Maybe Text
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.
tags :: Maybe [Tag]
The tags to be assigned to the restored cluster.
useLatestRestorableTime :: Maybe Bool
A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.
Default: false
Constraints: Cannot be specified if the RestoreToTime parameter is provided.
vpcSecurityGroupIds :: Maybe [Text]
A list of VPC security groups that the new cluster belongs to.
dbClusterIdentifier :: Text
The name of the new cluster to be created.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
sourceDBClusterIdentifier :: Text
The identifier of the source cluster from which to restore.
Constraints:
- Must match the identifier of an existing DBCluster.

Instances

Instances details

ToHeaders RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods toHeaders :: RestoreDBClusterToPointInTime -> [Header] #
ToPath RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods toPath :: RestoreDBClusterToPointInTime -> ByteString #
ToQuery RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods toQuery :: RestoreDBClusterToPointInTime -> QueryString #
AWSRequest RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Associated Types type AWSResponse RestoreDBClusterToPointInTime # Methods request :: (Service -> Service) -> RestoreDBClusterToPointInTime -> Request RestoreDBClusterToPointInTime # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreDBClusterToPointInTime -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreDBClusterToPointInTime))) #
Generic RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Associated Types type Rep RestoreDBClusterToPointInTime :: Type -> Type # Methods from :: RestoreDBClusterToPointInTime -> Rep RestoreDBClusterToPointInTime x # to :: Rep RestoreDBClusterToPointInTime x -> RestoreDBClusterToPointInTime #
Read RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods readsPrec :: Int -> ReadS RestoreDBClusterToPointInTime # readList :: ReadS [RestoreDBClusterToPointInTime] # readPrec :: ReadPrec RestoreDBClusterToPointInTime # readListPrec :: ReadPrec [RestoreDBClusterToPointInTime] #
Show RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods showsPrec :: Int -> RestoreDBClusterToPointInTime -> ShowS # show :: RestoreDBClusterToPointInTime -> String # showList :: [RestoreDBClusterToPointInTime] -> ShowS #
NFData RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods rnf :: RestoreDBClusterToPointInTime -> () #
Eq RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods (==) :: RestoreDBClusterToPointInTime -> RestoreDBClusterToPointInTime -> Bool # (/=) :: RestoreDBClusterToPointInTime -> RestoreDBClusterToPointInTime -> Bool #
Hashable RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods hashWithSalt :: Int -> RestoreDBClusterToPointInTime -> Int # hash :: RestoreDBClusterToPointInTime -> Int #
type AWSResponse RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime type AWSResponse RestoreDBClusterToPointInTime = RestoreDBClusterToPointInTimeResponse
type Rep RestoreDBClusterToPointInTime Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime type Rep RestoreDBClusterToPointInTime = D1 ('MetaData "RestoreDBClusterToPointInTime" "Amazonka.DocumentDB.RestoreDBClusterToPointInTime" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RestoreDBClusterToPointInTime'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "restoreToTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))) :: ((S1 ('MetaSel ('Just "restoreType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "useLatestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceDBClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRestoreDBClusterToPointInTime Source #

Arguments

:: Text	`RestoreDBClusterToPointInTime`
-> Text	`$sel:sourceDBClusterIdentifier:RestoreDBClusterToPointInTime'`
-> 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:

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_dbSubnetGroupName - The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

$sel:enableCloudwatchLogsExports:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_enableCloudwatchLogsExports - A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_kmsKeyId - The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

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

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source 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 occurs:

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

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

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_port - The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

$sel:restoreToTime:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_restoreToTime - The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

Must be before the latest restorable time for the instance.
Must be specified if the UseLatestRestorableTime parameter is not provided.
Cannot be specified if the UseLatestRestorableTime parameter is true.
Cannot be specified if the RestoreType parameter is copy-on-write.

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

$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:tags:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_tags - The tags to be assigned to the restored cluster.

$sel:useLatestRestorableTime:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_useLatestRestorableTime - A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

$sel:vpcSecurityGroupIds:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_vpcSecurityGroupIds - A list of VPC security groups that the new cluster belongs to.

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_dbClusterIdentifier - The name of the new cluster to be created.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The 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 cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster.

Request Lenses

restoreDBClusterToPointInTime_dbSubnetGroupName :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

restoreDBClusterToPointInTime_deletionProtection :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

restoreDBClusterToPointInTime_enableCloudwatchLogsExports :: Lens' RestoreDBClusterToPointInTime (Maybe [Text]) Source #

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

restoreDBClusterToPointInTime_kmsKeyId :: Lens' RestoreDBClusterToPointInTime (Maybe Text) Source #

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

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

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source 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 occurs:

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

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

restoreDBClusterToPointInTime_port :: Lens' RestoreDBClusterToPointInTime (Maybe Int) Source #

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

restoreDBClusterToPointInTime_restoreToTime :: Lens' RestoreDBClusterToPointInTime (Maybe UTCTime) Source #

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

Must be before the latest restorable time for the instance.
Must be specified if the UseLatestRestorableTime parameter is not provided.
Cannot be specified if the UseLatestRestorableTime parameter is true.
Cannot be specified if the RestoreType parameter is copy-on-write.

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

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_tags :: Lens' RestoreDBClusterToPointInTime (Maybe [Tag]) Source #

The tags to be assigned to the restored cluster.

restoreDBClusterToPointInTime_useLatestRestorableTime :: Lens' RestoreDBClusterToPointInTime (Maybe Bool) Source #

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

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

restoreDBClusterToPointInTime_vpcSecurityGroupIds :: Lens' RestoreDBClusterToPointInTime (Maybe [Text]) Source #

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

restoreDBClusterToPointInTime_dbClusterIdentifier :: Lens' RestoreDBClusterToPointInTime Text Source #

The name of the new cluster to be created.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The 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 cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster.

Destructuring the Response

data RestoreDBClusterToPointInTimeResponse Source #

See: newRestoreDBClusterToPointInTimeResponse smart constructor.

Constructors

RestoreDBClusterToPointInTimeResponse'
Fields dbCluster :: Maybe DBCluster httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RestoreDBClusterToPointInTimeResponse Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Associated Types type Rep RestoreDBClusterToPointInTimeResponse :: Type -> Type # Methods from :: RestoreDBClusterToPointInTimeResponse -> Rep RestoreDBClusterToPointInTimeResponse x # to :: Rep RestoreDBClusterToPointInTimeResponse x -> RestoreDBClusterToPointInTimeResponse #
Read RestoreDBClusterToPointInTimeResponse Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods readsPrec :: Int -> ReadS RestoreDBClusterToPointInTimeResponse # readList :: ReadS [RestoreDBClusterToPointInTimeResponse] # readPrec :: ReadPrec RestoreDBClusterToPointInTimeResponse # readListPrec :: ReadPrec [RestoreDBClusterToPointInTimeResponse] #
Show RestoreDBClusterToPointInTimeResponse Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods showsPrec :: Int -> RestoreDBClusterToPointInTimeResponse -> ShowS # show :: RestoreDBClusterToPointInTimeResponse -> String # showList :: [RestoreDBClusterToPointInTimeResponse] -> ShowS #
NFData RestoreDBClusterToPointInTimeResponse Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods rnf :: RestoreDBClusterToPointInTimeResponse -> () #
Eq RestoreDBClusterToPointInTimeResponse Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime Methods (==) :: RestoreDBClusterToPointInTimeResponse -> RestoreDBClusterToPointInTimeResponse -> Bool # (/=) :: RestoreDBClusterToPointInTimeResponse -> RestoreDBClusterToPointInTimeResponse -> Bool #
type Rep RestoreDBClusterToPointInTimeResponse Source #
Instance details Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime type Rep RestoreDBClusterToPointInTimeResponse = D1 ('MetaData "RestoreDBClusterToPointInTimeResponse" "Amazonka.DocumentDB.RestoreDBClusterToPointInTime" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RestoreDBClusterToPointInTimeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRestoreDBClusterToPointInTimeResponse Source #

Arguments

:: Int	`$sel:httpStatus:RestoreDBClusterToPointInTimeResponse'`
-> RestoreDBClusterToPointInTimeResponse

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.