View a markdown version of this page

AWS::Neptune::GlobalCluster - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Neptune::GlobalCluster

The AWS::Neptune::GlobalCluster resource creates an Amazon Neptune global database spread across multiple AWS 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.

Note

Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.

When DeletionPolicy is set for the AWS::Neptune::GlobalCluster resource, it can not be deleted. The default behavior is to have no deletion protection. Before deletion, the primary and all secondary clusters must already be detached or deleted first. For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute.

You can use AWS::Neptune::GlobalCluster.DeletionProtection to help guard against unintended deletion of your global database.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Neptune::GlobalCluster",
  "Properties" : {
      "DeletionProtection" : Boolean,
      "Engine" : String,
      "EngineVersion" : String,
      "GlobalClusterIdentifier" : String,
      "SourceDBClusterIdentifier" : String,
      "StorageEncrypted" : Boolean,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Neptune::GlobalCluster
Properties:
  DeletionProtection: Boolean
  Engine: String
  EngineVersion: String
  GlobalClusterIdentifier: String
  SourceDBClusterIdentifier: String
  StorageEncrypted: Boolean
  Tags: 
    - Tag

Properties

DeletionProtection

The deletion protection setting for the global database.

Required: No

Type: Boolean

Update requires: No interruption

Engine

The Neptune database engine used by the global database.

Required: No

Type: String

Allowed values: neptune

Update requires: Replacement

EngineVersion

The Neptune engine version used by the global database. The minimum supported engine version is 1.2.0.0.

Required: No

Type: String

Update requires: No interruption

GlobalClusterIdentifier

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

If it's not specified, then a random one will be automatically generated.

Required: No

Type: String

Pattern: ^[A-Za-z][0-9A-Za-z-:._]*$

Minimum: 1

Maximum: 255

Update requires: Replacement

SourceDBClusterIdentifier

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

Note

If you specify this property, the new global cluster inherits the engine version and storage-encryption settings of the source DB cluster, so the Engine, EngineVersion, and StorageEncrypted properties must not also be specified.

Required: No

Type: String

Update requires: Replacement

StorageEncrypted

The storage encryption setting for the global database.

Required: No

Type: Boolean

Update requires: Replacement

Tags

The tags assigned to this global cluster.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name.

For more information about using the Ref function, see Ref.