AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateGlobalCluster operation. Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

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

This action only applies to Amazon DocumentDB clusters.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DocDB.AmazonDocDBRequest
      Amazon.DocDB.Model.CreateGlobalClusterRequest

Namespace: Amazon.DocDB.Model
Assembly: AWSSDK.DocDB.dll
Version: 3.x.y.z

Syntax

C#
public class CreateGlobalClusterRequest : AmazonDocDBRequest
         IAmazonWebServiceRequest

The CreateGlobalClusterRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DatabaseName System.String

Gets and sets the property DatabaseName.

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

Public Property DeletionProtection System.Boolean

Gets and sets the property DeletionProtection.

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

Public Property Engine System.String

Gets and sets the property Engine.

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

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

The engine version of the global cluster.

Public Property GlobalClusterIdentifier System.String

Gets and sets the property GlobalClusterIdentifier.

The cluster identifier of the new global cluster.

Public Property SourceDBClusterIdentifier System.String

Gets and sets the property SourceDBClusterIdentifier.

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

Public Property StorageEncrypted System.Boolean

Gets and sets the property StorageEncrypted.

The storage encryption setting for the new global cluster.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5