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.Neptune.CreateGlobalCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.

Synopsis

Creating a Request

data CreateGlobalCluster Source #

See: newCreateGlobalCluster smart constructor.

Constructors

CreateGlobalCluster'

Fields

deletionProtection :: Maybe Bool
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
engine :: Maybe Text
The name of the database engine to be used in the global database.
Valid values: neptune
engineVersion :: Maybe Text
The Neptune engine version to be used by the global database.
Valid values: 1.2.0.0 or above.
sourceDBClusterIdentifier :: Maybe Text
(Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.
storageEncrypted :: Maybe Bool
The storage encryption setting for the new global database cluster.
globalClusterIdentifier :: Text
The cluster identifier of the new global database cluster.

Instances

Instances details

ToHeaders CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Methods toHeaders :: CreateGlobalCluster -> [Header] #
ToPath CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Methods toPath :: CreateGlobalCluster -> ByteString #
ToQuery CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Methods toQuery :: CreateGlobalCluster -> QueryString #
AWSRequest CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Associated Types type AWSResponse CreateGlobalCluster # Methods request :: (Service -> Service) -> CreateGlobalCluster -> Request CreateGlobalCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateGlobalCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGlobalCluster))) #
Generic CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Associated Types type Rep CreateGlobalCluster :: Type -> Type # Methods from :: CreateGlobalCluster -> Rep CreateGlobalCluster x # to :: Rep CreateGlobalCluster x -> CreateGlobalCluster #
Read CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Methods readsPrec :: Int -> ReadS CreateGlobalCluster # readList :: ReadS [CreateGlobalCluster] # readPrec :: ReadPrec CreateGlobalCluster # readListPrec :: ReadPrec [CreateGlobalCluster] #
Show CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Methods showsPrec :: Int -> CreateGlobalCluster -> ShowS # show :: CreateGlobalCluster -> String # showList :: [CreateGlobalCluster] -> ShowS #
NFData CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Methods rnf :: CreateGlobalCluster -> () #
Eq CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Methods (==) :: CreateGlobalCluster -> CreateGlobalCluster -> Bool # (/=) :: CreateGlobalCluster -> CreateGlobalCluster -> Bool #
Hashable CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster Methods hashWithSalt :: Int -> CreateGlobalCluster -> Int # hash :: CreateGlobalCluster -> Int #
type AWSResponse CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster type AWSResponse CreateGlobalCluster = CreateGlobalClusterResponse
type Rep CreateGlobalCluster Source #
Instance details Defined in Amazonka.Neptune.CreateGlobalCluster type Rep CreateGlobalCluster = D1 ('MetaData "CreateGlobalCluster" "Amazonka.Neptune.CreateGlobalCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "CreateGlobalCluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "sourceDBClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateGlobalCluster Source #

Arguments

:: Text	`CreateGlobalCluster`
-> CreateGlobalCluster

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

CreateGlobalCluster, createGlobalCluster_deletionProtection - The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

CreateGlobalCluster, createGlobalCluster_engine - The name of the database engine to be used in the global database.

Valid values: neptune

CreateGlobalCluster, createGlobalCluster_engineVersion - The Neptune engine version to be used by the global database.

Valid values: 1.2.0.0 or above.

$sel:sourceDBClusterIdentifier:CreateGlobalCluster', createGlobalCluster_sourceDBClusterIdentifier - (Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

CreateGlobalCluster, createGlobalCluster_storageEncrypted - The storage encryption setting for the new global database cluster.

CreateGlobalCluster, createGlobalCluster_globalClusterIdentifier - The cluster identifier of the new global database cluster.

Request Lenses

createGlobalCluster_deletionProtection :: Lens' CreateGlobalCluster (Maybe Bool) Source #

The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

createGlobalCluster_engine :: Lens' CreateGlobalCluster (Maybe Text) Source #

The name of the database engine to be used in the global database.

Valid values: neptune

createGlobalCluster_engineVersion :: Lens' CreateGlobalCluster (Maybe Text) Source #

The Neptune engine version to be used by the global database.

Valid values: 1.2.0.0 or above.

createGlobalCluster_sourceDBClusterIdentifier :: Lens' CreateGlobalCluster (Maybe Text) Source #

(Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

createGlobalCluster_storageEncrypted :: Lens' CreateGlobalCluster (Maybe Bool) Source #

The storage encryption setting for the new global database cluster.

createGlobalCluster_globalClusterIdentifier :: Lens' CreateGlobalCluster Text Source #

The cluster identifier of the new global database cluster.

Destructuring the Response

data CreateGlobalClusterResponse Source #

See: newCreateGlobalClusterResponse smart constructor.

Constructors

CreateGlobalClusterResponse'
Fields globalCluster :: Maybe GlobalCluster httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateGlobalClusterResponse Source #

Arguments

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

Create a value of CreateGlobalClusterResponse 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:globalCluster:CreateGlobalClusterResponse', createGlobalClusterResponse_globalCluster - Undocumented member.

$sel:httpStatus:CreateGlobalClusterResponse', createGlobalClusterResponse_httpStatus - The response's http status code.

Response Lenses

createGlobalClusterResponse_globalCluster :: Lens' CreateGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

createGlobalClusterResponse_httpStatus :: Lens' CreateGlobalClusterResponse Int Source #

The response's http status code.