rds_create_global_cluster: Creates an Aurora global database spread across multiple AWS...

Description Usage Arguments Value Request syntax

View source: R/rds_operations.R

Description

Creates an Aurora global database spread across multiple AWS 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.

Usage

1
2
3
rds_create_global_cluster(GlobalClusterIdentifier,
  SourceDBClusterIdentifier, Engine, EngineVersion, DeletionProtection,
  DatabaseName, StorageEncrypted)

Arguments

GlobalClusterIdentifier

The cluster identifier of the new global database cluster.

SourceDBClusterIdentifier

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

Engine

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

EngineVersion

The engine version of the Aurora global database.

DeletionProtection

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

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.

StorageEncrypted

The storage encryption setting for the new global database cluster.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
list(
  GlobalCluster = list(
    GlobalClusterIdentifier = "string",
    GlobalClusterResourceId = "string",
    GlobalClusterArn = "string",
    Status = "string",
    Engine = "string",
    EngineVersion = "string",
    DatabaseName = "string",
    StorageEncrypted = TRUE|FALSE,
    DeletionProtection = TRUE|FALSE,
    GlobalClusterMembers = list(
      list(
        DBClusterArn = "string",
        Readers = list(
          "string"
        ),
        IsWriter = TRUE|FALSE,
        GlobalWriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"unknown"
      )
    )
  )
)

Request syntax

1
2
3
4
5
6
7
8
9
svc$create_global_cluster(
  GlobalClusterIdentifier = "string",
  SourceDBClusterIdentifier = "string",
  Engine = "string",
  EngineVersion = "string",
  DeletionProtection = TRUE|FALSE,
  DatabaseName = "string",
  StorageEncrypted = TRUE|FALSE
)

paws.database documentation built on Aug. 23, 2021, 9:18 a.m.