GlobalCluster
A data type representing an Aurora global database.
Contents
Note
In the following list, the required parameters are described first.
- DatabaseName
-
The default database name within the new global database cluster.
Type: String
Required: No
- DeletionProtection
-
The deletion protection setting for the new global database cluster.
Type: Boolean
Required: No
- Engine
-
The Aurora database engine used by the global database cluster.
Type: String
Required: No
- EngineLifecycleSupport
-
The life cycle type for the global cluster.
For more information, see CreateGlobalCluster.
Type: String
Required: No
- EngineVersion
-
Indicates the database engine version.
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 (Aurora 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 cluster.
Type: String
Required: No
- GlobalClusterIdentifier
-
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
Type: String
Required: No
- GlobalClusterMembers.GlobalClusterMember.N
-
The list of primary and secondary clusters within the global database cluster.
Type: Array of GlobalClusterMember objects
Required: No
- GlobalClusterResourceId
-
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
Type: String
Required: No
- Status
-
Specifies the current state of this global database cluster.
Type: String
Required: No
- StorageEncrypted
-
The storage encryption setting for the global database cluster.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: