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.RestoreDBClusterFromSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

Synopsis

Creating a Request

data RestoreDBClusterFromSnapshot Source #

Represents the input to RestoreDBClusterFromSnapshot.

See: newRestoreDBClusterFromSnapshot smart constructor.

Constructors

RestoreDBClusterFromSnapshot'

Fields

availabilityZones :: Maybe [Text]
Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
dbSubnetGroupName :: Maybe Text
The name of the subnet group 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.
engineVersion :: Maybe Text
The version of the database engine to use for the new cluster.
kmsKeyId :: Maybe Text
The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
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.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
- If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
- If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
port :: Maybe Int
The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150 to 65535.
Default: The same port as the original cluster.
tags :: Maybe [Tag]
The tags to be assigned to the restored cluster.
vpcSecurityGroupIds :: Maybe [Text]
A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
dbClusterIdentifier :: Text
The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.
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.
Example: my-snapshot-id
snapshotIdentifier :: Text
The identifier for the snapshot or cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.
Constraints:
- Must match the identifier of an existing snapshot.
engine :: Text
The database engine to use for the new cluster.
Default: The same as source.
Constraint: Must be compatible with the engine of the source.

Instances

Instances details

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

newRestoreDBClusterFromSnapshot Source #

Arguments

:: Text	`RestoreDBClusterFromSnapshot`
-> Text	`$sel:snapshotIdentifier:RestoreDBClusterFromSnapshot'`
-> Text	`RestoreDBClusterFromSnapshot`
-> RestoreDBClusterFromSnapshot

Create a value of RestoreDBClusterFromSnapshot 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:

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_dbSubnetGroupName - The name of the subnet group to use for the new cluster.

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

Example: mySubnetgroup

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_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:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_enableCloudwatchLogsExports - A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_engineVersion - The version of the database engine to use for the new cluster.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_kmsKeyId - The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

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.

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

If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_port - The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

$sel:tags:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_tags - The tags to be assigned to the restored cluster.

$sel:vpcSecurityGroupIds:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_vpcSecurityGroupIds - A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_dbClusterIdentifier - The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

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.

Example: my-snapshot-id

$sel:snapshotIdentifier:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_snapshotIdentifier - The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

Must match the identifier of an existing snapshot.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_engine - The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Request Lenses

restoreDBClusterFromSnapshot_availabilityZones :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

restoreDBClusterFromSnapshot_dbSubnetGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

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

Example: mySubnetgroup

restoreDBClusterFromSnapshot_deletionProtection :: Lens' RestoreDBClusterFromSnapshot (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.

restoreDBClusterFromSnapshot_enableCloudwatchLogsExports :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

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

restoreDBClusterFromSnapshot_engineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

The version of the database engine to use for the new cluster.

restoreDBClusterFromSnapshot_kmsKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #

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

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.

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

If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

restoreDBClusterFromSnapshot_port :: Lens' RestoreDBClusterFromSnapshot (Maybe Int) Source #

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

restoreDBClusterFromSnapshot_tags :: Lens' RestoreDBClusterFromSnapshot (Maybe [Tag]) Source #

The tags to be assigned to the restored cluster.

restoreDBClusterFromSnapshot_vpcSecurityGroupIds :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

restoreDBClusterFromSnapshot_dbClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

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.

Example: my-snapshot-id

restoreDBClusterFromSnapshot_snapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

Must match the identifier of an existing snapshot.

restoreDBClusterFromSnapshot_engine :: Lens' RestoreDBClusterFromSnapshot Text Source #

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Destructuring the Response

data RestoreDBClusterFromSnapshotResponse Source #

See: newRestoreDBClusterFromSnapshotResponse smart constructor.

Constructors

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

Instances

Instances details

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

newRestoreDBClusterFromSnapshotResponse Source #

Arguments

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

Create a value of RestoreDBClusterFromSnapshotResponse 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:RestoreDBClusterFromSnapshotResponse', restoreDBClusterFromSnapshotResponse_dbCluster - Undocumented member.

$sel:httpStatus:RestoreDBClusterFromSnapshotResponse', restoreDBClusterFromSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

restoreDBClusterFromSnapshotResponse_dbCluster :: Lens' RestoreDBClusterFromSnapshotResponse (Maybe DBCluster) Source #

Undocumented member.

restoreDBClusterFromSnapshotResponse_httpStatus :: Lens' RestoreDBClusterFromSnapshotResponse Int Source #

The response's http status code.