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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

This action applies only to Aurora DB clusters.

Synopsis

Creating a Request

data CreateGlobalCluster Source #

See: newCreateGlobalCluster smart constructor.

Constructors

CreateGlobalCluster'

Fields

databaseName :: Maybe Text
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.
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 for this DB cluster.
engineVersion :: Maybe Text
The engine version of the Aurora global database.
globalClusterIdentifier :: Maybe Text
The cluster identifier of the new global database cluster.
sourceDBClusterIdentifier :: Maybe Text
The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.
storageEncrypted :: Maybe Bool
The storage encryption setting for the new global database cluster.

Instances

Instances details

ToHeaders CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods toHeaders :: CreateGlobalCluster -> [Header] #
ToPath CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods toPath :: CreateGlobalCluster -> ByteString #
ToQuery CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods toQuery :: CreateGlobalCluster -> QueryString #
AWSRequest CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.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.RDS.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.RDS.CreateGlobalCluster Methods readsPrec :: Int -> ReadS CreateGlobalCluster # readList :: ReadS [CreateGlobalCluster] # readPrec :: ReadPrec CreateGlobalCluster # readListPrec :: ReadPrec [CreateGlobalCluster] #
Show CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods showsPrec :: Int -> CreateGlobalCluster -> ShowS # show :: CreateGlobalCluster -> String # showList :: [CreateGlobalCluster] -> ShowS #
NFData CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods rnf :: CreateGlobalCluster -> () #
Eq CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods (==) :: CreateGlobalCluster -> CreateGlobalCluster -> Bool # (/=) :: CreateGlobalCluster -> CreateGlobalCluster -> Bool #
Hashable CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods hashWithSalt :: Int -> CreateGlobalCluster -> Int # hash :: CreateGlobalCluster -> Int #
type AWSResponse CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster type AWSResponse CreateGlobalCluster = CreateGlobalClusterResponse
type Rep CreateGlobalCluster Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster type Rep CreateGlobalCluster = D1 ('MetaData "CreateGlobalCluster" "Amazonka.RDS.CreateGlobalCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CreateGlobalCluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (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 "globalClusterIdentifier") '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))))))

newCreateGlobalCluster :: CreateGlobalCluster Source #

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_databaseName - The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

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 for this DB cluster.

CreateGlobalCluster, createGlobalCluster_engineVersion - The engine version of the Aurora global database.

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

$sel:sourceDBClusterIdentifier:CreateGlobalCluster', createGlobalCluster_sourceDBClusterIdentifier - The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.

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

Request Lenses

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

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 for this DB cluster.

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

The engine version of the Aurora global database.

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

The cluster identifier of the new global database cluster.

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

The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.

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

The storage encryption setting for 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.RDS.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.RDS.CreateGlobalCluster Methods readsPrec :: Int -> ReadS CreateGlobalClusterResponse # readList :: ReadS [CreateGlobalClusterResponse] # readPrec :: ReadPrec CreateGlobalClusterResponse # readListPrec :: ReadPrec [CreateGlobalClusterResponse] #
Show CreateGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods showsPrec :: Int -> CreateGlobalClusterResponse -> ShowS # show :: CreateGlobalClusterResponse -> String # showList :: [CreateGlobalClusterResponse] -> ShowS #
NFData CreateGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods rnf :: CreateGlobalClusterResponse -> () #
Eq CreateGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster Methods (==) :: CreateGlobalClusterResponse -> CreateGlobalClusterResponse -> Bool # (/=) :: CreateGlobalClusterResponse -> CreateGlobalClusterResponse -> Bool #
type Rep CreateGlobalClusterResponse Source #
Instance details Defined in Amazonka.RDS.CreateGlobalCluster type Rep CreateGlobalClusterResponse = D1 ('MetaData "CreateGlobalClusterResponse" "Amazonka.RDS.CreateGlobalCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" '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.