libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.CreateGlobalCluster

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 only applies to Aurora DB clusters.

Synopsis

Creating a Request

data CreateGlobalCluster Source #

See: newCreateGlobalCluster smart constructor.

Constructors

CreateGlobalCluster' 

Fields

Instances

Instances details
Eq CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Read CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Show CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Generic CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Associated Types

type Rep CreateGlobalCluster :: Type -> Type #

NFData CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Methods

rnf :: CreateGlobalCluster -> () #

Hashable CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

AWSRequest CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Associated Types

type AWSResponse CreateGlobalCluster #

ToHeaders CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

ToPath CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

ToQuery CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

type Rep CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

type Rep CreateGlobalCluster = D1 ('MetaData "CreateGlobalCluster" "Amazonka.RDS.CreateGlobalCluster" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CreateGlobalCluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "sourceDBClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

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:

$sel:engineVersion:CreateGlobalCluster', createGlobalCluster_engineVersion - The engine version of the Aurora global database.

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

$sel:storageEncrypted:CreateGlobalCluster', createGlobalCluster_storageEncrypted - The storage encryption setting for 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.

$sel:globalClusterIdentifier:CreateGlobalCluster', createGlobalCluster_globalClusterIdentifier - The cluster identifier of the new global database cluster.

$sel:engine:CreateGlobalCluster', createGlobalCluster_engine - The name of the database engine to be used for this DB cluster.

$sel:databaseName:CreateGlobalCluster', createGlobalCluster_databaseName - The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

Request Lenses

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

The engine version of the Aurora global database.

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_storageEncrypted :: Lens' CreateGlobalCluster (Maybe Bool) Source #

The storage encryption setting for 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_globalClusterIdentifier :: Lens' CreateGlobalCluster (Maybe Text) Source #

The cluster identifier of the new global database cluster.

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

The name of the database engine to be used for this DB cluster.

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

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

Destructuring the Response

data CreateGlobalClusterResponse Source #

See: newCreateGlobalClusterResponse smart constructor.

Constructors

CreateGlobalClusterResponse' 

Fields

Instances

Instances details
Eq CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Read CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Show CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Generic CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

Associated Types

type Rep CreateGlobalClusterResponse :: Type -> Type #

NFData CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

type Rep CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateGlobalCluster

type Rep CreateGlobalClusterResponse = D1 ('MetaData "CreateGlobalClusterResponse" "Amazonka.RDS.CreateGlobalCluster" "libZSservicesZSamazonka-rdsZSamazonka-rds" '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 #

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