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.DocDbElastic.RestoreClusterFromSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Restores a Elastic DocumentDB cluster from a snapshot.

Synopsis

Creating a Request

data RestoreClusterFromSnapshot Source #

See: newRestoreClusterFromSnapshot smart constructor.

Constructors

RestoreClusterFromSnapshot'

Fields

kmsKeyId :: Maybe Text
The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified here, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
subnetIds :: Maybe [Text]
The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
tags :: Maybe (HashMap Text Text)
A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
vpcSecurityGroupIds :: Maybe [Text]
A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.
clusterName :: Text
The name of the Elastic DocumentDB cluster.
snapshotArn :: Text
The arn of the Elastic DocumentDB snapshot.

Instances

Instances details

ToJSON RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods toJSON :: RestoreClusterFromSnapshot -> Value # toEncoding :: RestoreClusterFromSnapshot -> Encoding # toJSONList :: [RestoreClusterFromSnapshot] -> Value # toEncodingList :: [RestoreClusterFromSnapshot] -> Encoding #
ToHeaders RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods toHeaders :: RestoreClusterFromSnapshot -> [Header] #
ToPath RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods toPath :: RestoreClusterFromSnapshot -> ByteString #
ToQuery RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods toQuery :: RestoreClusterFromSnapshot -> QueryString #
AWSRequest RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Associated Types type AWSResponse RestoreClusterFromSnapshot # Methods request :: (Service -> Service) -> RestoreClusterFromSnapshot -> Request RestoreClusterFromSnapshot # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreClusterFromSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreClusterFromSnapshot))) #
Generic RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Associated Types type Rep RestoreClusterFromSnapshot :: Type -> Type # Methods from :: RestoreClusterFromSnapshot -> Rep RestoreClusterFromSnapshot x # to :: Rep RestoreClusterFromSnapshot x -> RestoreClusterFromSnapshot #
Read RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods readsPrec :: Int -> ReadS RestoreClusterFromSnapshot # readList :: ReadS [RestoreClusterFromSnapshot] # readPrec :: ReadPrec RestoreClusterFromSnapshot # readListPrec :: ReadPrec [RestoreClusterFromSnapshot] #
Show RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods showsPrec :: Int -> RestoreClusterFromSnapshot -> ShowS # show :: RestoreClusterFromSnapshot -> String # showList :: [RestoreClusterFromSnapshot] -> ShowS #
NFData RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods rnf :: RestoreClusterFromSnapshot -> () #
Eq RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods (==) :: RestoreClusterFromSnapshot -> RestoreClusterFromSnapshot -> Bool # (/=) :: RestoreClusterFromSnapshot -> RestoreClusterFromSnapshot -> Bool #
Hashable RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot Methods hashWithSalt :: Int -> RestoreClusterFromSnapshot -> Int # hash :: RestoreClusterFromSnapshot -> Int #
type AWSResponse RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot type AWSResponse RestoreClusterFromSnapshot = RestoreClusterFromSnapshotResponse
type Rep RestoreClusterFromSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot type Rep RestoreClusterFromSnapshot = D1 ('MetaData "RestoreClusterFromSnapshot" "Amazonka.DocDbElastic.RestoreClusterFromSnapshot" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "RestoreClusterFromSnapshot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "snapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newRestoreClusterFromSnapshot Source #

Arguments

:: Text	`RestoreClusterFromSnapshot`
-> Text	`RestoreClusterFromSnapshot`
-> RestoreClusterFromSnapshot

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

RestoreClusterFromSnapshot, restoreClusterFromSnapshot_kmsKeyId - The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified here, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

RestoreClusterFromSnapshot, restoreClusterFromSnapshot_subnetIds - The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

$sel:tags:RestoreClusterFromSnapshot', restoreClusterFromSnapshot_tags - A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

RestoreClusterFromSnapshot, restoreClusterFromSnapshot_vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.

RestoreClusterFromSnapshot, restoreClusterFromSnapshot_clusterName - The name of the Elastic DocumentDB cluster.

RestoreClusterFromSnapshot, restoreClusterFromSnapshot_snapshotArn - The arn of the Elastic DocumentDB snapshot.

Request Lenses

restoreClusterFromSnapshot_kmsKeyId :: Lens' RestoreClusterFromSnapshot (Maybe Text) Source #

The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified here, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

restoreClusterFromSnapshot_subnetIds :: Lens' RestoreClusterFromSnapshot (Maybe [Text]) Source #

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

restoreClusterFromSnapshot_tags :: Lens' RestoreClusterFromSnapshot (Maybe (HashMap Text Text)) Source #

A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

restoreClusterFromSnapshot_vpcSecurityGroupIds :: Lens' RestoreClusterFromSnapshot (Maybe [Text]) Source #

A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.

restoreClusterFromSnapshot_clusterName :: Lens' RestoreClusterFromSnapshot Text Source #

The name of the Elastic DocumentDB cluster.

restoreClusterFromSnapshot_snapshotArn :: Lens' RestoreClusterFromSnapshot Text Source #

The arn of the Elastic DocumentDB snapshot.

Destructuring the Response

data RestoreClusterFromSnapshotResponse Source #

See: newRestoreClusterFromSnapshotResponse smart constructor.

Constructors

RestoreClusterFromSnapshotResponse'
Fields httpStatus :: Int The response's http status code. cluster :: Cluster Returns information about a the restored Elastic DocumentDB cluster.

Instances

Instances details

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

newRestoreClusterFromSnapshotResponse Source #

Arguments

:: Int	`$sel:httpStatus:RestoreClusterFromSnapshotResponse'`
-> Cluster	`$sel:cluster:RestoreClusterFromSnapshotResponse'`
-> RestoreClusterFromSnapshotResponse

Create a value of RestoreClusterFromSnapshotResponse 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:httpStatus:RestoreClusterFromSnapshotResponse', restoreClusterFromSnapshotResponse_httpStatus - The response's http status code.

$sel:cluster:RestoreClusterFromSnapshotResponse', restoreClusterFromSnapshotResponse_cluster - Returns information about a the restored Elastic DocumentDB cluster.

Response Lenses

restoreClusterFromSnapshotResponse_httpStatus :: Lens' RestoreClusterFromSnapshotResponse Int Source #

The response's http status code.

restoreClusterFromSnapshotResponse_cluster :: Lens' RestoreClusterFromSnapshotResponse Cluster Source #

Returns information about a the restored Elastic DocumentDB cluster.