2025/05/16 - Amazon Neptune - 1 new 6 updated api methods
Changes This release adds Global Cluster Switchover capability which enables you to change your global cluster's primary AWS Region, the region that serves writes, while preserving the replication between all regions in the global cluster.
Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."
Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the original replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles.
See also: AWS API Documentation
Request Syntax
client.switchover_global_cluster( GlobalClusterIdentifier='string', TargetDbClusterIdentifier='string' )
string
[REQUIRED]
The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.
Constraints: Must match the identifier of an existing global database cluster.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.
dict
Response Syntax
{ 'GlobalCluster': { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False }, ], 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False } } }
Response Structure
(dict) --
GlobalCluster (dict) --
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.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
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.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
FailoverState (dict) --
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 or FailoverGlobalCluster operation was called on this global cluster.
Status (string) --
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
IsDataLossAllowed (boolean) --
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string', 'IsDataLossAllowed': 'boolean', 'Status': 'pending | failing-over | ' 'cancelling', 'ToDbClusterArn': 'string'}}}
Creates a Neptune global database spread across multiple Amazon 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.
You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.
See also: AWS API Documentation
Request Syntax
client.create_global_cluster( GlobalClusterIdentifier='string', SourceDBClusterIdentifier='string', Engine='string', EngineVersion='string', DeletionProtection=True|False, StorageEncrypted=True|False )
string
[REQUIRED]
The cluster identifier of the new global database cluster.
string
(Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.
string
The name of the database engine to be used in the global database.
Valid values: neptune
string
The Neptune engine version to be used by the global database.
Valid values: 1.2.0.0 or above.
boolean
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
boolean
The storage encryption setting for the new global database cluster.
dict
Response Syntax
{ 'GlobalCluster': { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False }, ], 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False } } }
Response Structure
(dict) --
GlobalCluster (dict) --
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.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
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.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
FailoverState (dict) --
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 or FailoverGlobalCluster operation was called on this global cluster.
Status (string) --
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
IsDataLossAllowed (boolean) --
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string', 'IsDataLossAllowed': 'boolean', 'Status': 'pending | failing-over | ' 'cancelling', 'ToDbClusterArn': 'string'}}}
Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
See also: AWS API Documentation
Request Syntax
client.delete_global_cluster( GlobalClusterIdentifier='string' )
string
[REQUIRED]
The cluster identifier of the global database cluster being deleted.
dict
Response Syntax
{ 'GlobalCluster': { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False }, ], 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False } } }
Response Structure
(dict) --
GlobalCluster (dict) --
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.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
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.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
FailoverState (dict) --
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 or FailoverGlobalCluster operation was called on this global cluster.
Status (string) --
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
IsDataLossAllowed (boolean) --
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
{'GlobalClusters': {'FailoverState': {'FromDbClusterArn': 'string', 'IsDataLossAllowed': 'boolean', 'Status': 'pending | failing-over | ' 'cancelling', 'ToDbClusterArn': 'string'}}}
Returns information about Neptune global database clusters. This API supports pagination.
See also: AWS API Documentation
Request Syntax
client.describe_global_clusters( GlobalClusterIdentifier='string', MaxRecords=123, Marker='string' )
string
The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.
Constraints: If supplied, must match an existing DB cluster identifier.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination marker token is included in the response that you can use to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
string
(Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by MaxRecords.
dict
Response Syntax
{ 'Marker': 'string', 'GlobalClusters': [ { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False }, ], 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False } }, ] }
Response Structure
(dict) --
Marker (string) --
A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to DescribeGlobalClusters.
GlobalClusters (list) --
The list of global clusters and instances returned by this request.
(dict) --
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.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
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.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
FailoverState (dict) --
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 or FailoverGlobalCluster operation was called on this global cluster.
Status (string) --
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
IsDataLossAllowed (boolean) --
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
{'AllowDataLoss': 'boolean', 'Switchover': 'boolean'}Response
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string', 'IsDataLossAllowed': 'boolean', 'Status': 'pending | failing-over | ' 'cancelling', 'ToDbClusterArn': 'string'}}}
Initiates the failover process for a Neptune global database.
A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.
See also: AWS API Documentation
Request Syntax
client.failover_global_cluster( GlobalClusterIdentifier='string', TargetDbClusterIdentifier='string', AllowDataLoss=True|False, Switchover=True|False )
string
[REQUIRED]
Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.
Constraints: Must match the identifier of an existing Neptune global database.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.
boolean
Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.
Constraints:Can't be specified together with the Switchover parameter.
boolean
Specifies whether to switch over this global database cluster.
Constraints:Can't be specified together with the AllowDataLoss parameter.
dict
Response Syntax
{ 'GlobalCluster': { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False }, ], 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False } } }
Response Structure
(dict) --
GlobalCluster (dict) --
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.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
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.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
FailoverState (dict) --
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 or FailoverGlobalCluster operation was called on this global cluster.
Status (string) --
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
IsDataLossAllowed (boolean) --
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string', 'IsDataLossAllowed': 'boolean', 'Status': 'pending | failing-over | ' 'cancelling', 'ToDbClusterArn': 'string'}}}
Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.
See also: AWS API Documentation
Request Syntax
client.modify_global_cluster( GlobalClusterIdentifier='string', NewGlobalClusterIdentifier='string', DeletionProtection=True|False, EngineVersion='string', AllowMajorVersionUpgrade=True|False )
string
[REQUIRED]
The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.
Constraints: Must match the identifier of an existing global database cluster.
string
A new cluster identifier to assign to the global database. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
boolean
Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.
string
The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
To list all of the available Neptune engine versions, use the following command:
boolean
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades if you specify a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.
dict
Response Syntax
{ 'GlobalCluster': { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False }, ], 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False } } }
Response Structure
(dict) --
GlobalCluster (dict) --
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.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
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.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
FailoverState (dict) --
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 or FailoverGlobalCluster operation was called on this global cluster.
Status (string) --
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
IsDataLossAllowed (boolean) --
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string', 'IsDataLossAllowed': 'boolean', 'Status': 'pending | failing-over | ' 'cancelling', 'ToDbClusterArn': 'string'}}}
Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.
See also: AWS API Documentation
Request Syntax
client.remove_from_global_cluster( GlobalClusterIdentifier='string', DbClusterIdentifier='string' )
string
[REQUIRED]
The identifier of the Neptune global database from which to detach the specified Neptune DB cluster.
string
[REQUIRED]
The Amazon Resource Name (ARN) identifying the cluster to be detached from the Neptune global database cluster.
dict
Response Syntax
{ 'GlobalCluster': { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False }, ], 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False } } }
Response Structure
(dict) --
GlobalCluster (dict) --
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.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
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.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
FailoverState (dict) --
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 or FailoverGlobalCluster operation was called on this global cluster.
Status (string) --
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
IsDataLossAllowed (boolean) --
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.