GlobalCluster
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
Contents
- DeletionProtection
-
The deletion protection setting for the global database.
Type: Boolean
Required: No
- Engine
-
The Neptune database engine used by the global database (
"neptune"
).Type: String
Required: No
- EngineVersion
-
The Neptune engine version used by the global database.
Type: String
Required: No
- FailoverState
-
A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Neptune global database). This object is empty unless the
SwitchoverGlobalCluster
orFailoverGlobalCluster
operation was called on this global cluster.Type: FailoverState object
Required: No
- GlobalClusterArn
-
The Amazon Resource Name (ARN) for the global database.
Type: String
Required: No
- GlobalClusterIdentifier
-
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][0-9A-Za-z-:._]*
Required: No
- GlobalClusterMembers.GlobalClusterMember.N
-
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
Type: Array of GlobalClusterMember objects
Required: No
- GlobalClusterResourceId
-
An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
Type: String
Required: No
- Status
-
Specifies the current state of this global database.
Type: String
Required: No
- StorageEncrypted
-
The storage encryption setting for the global database.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: