2025/10/30 - Amazon DocumentDB with MongoDB compatibility - 7 updated api methods
Changes Adding FailoverState and TagList to GlobalCluster and SynchronizationStatus to GlobalClusterMember.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'IsDataLossAllowed': 'boolean',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'},
'GlobalClusterMembers': {'SynchronizationStatus': 'connected '
'| '
'pending-resync'},
'TagList': [{'Key': 'string', 'Value': 'string'}]}}
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 10 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.
See also: AWS API Documentation
Request Syntax
client.create_global_cluster(
GlobalClusterIdentifier='string',
SourceDBClusterIdentifier='string',
Engine='string',
EngineVersion='string',
DeletionProtection=True|False,
DatabaseName='string',
StorageEncrypted=True|False
)
string
[REQUIRED]
The cluster identifier of the new global cluster.
string
The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.
string
The name of the database engine to be used for this cluster.
string
The engine version of the global cluster.
boolean
The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.
string
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.
boolean
The storage encryption setting for the new global cluster.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'SynchronizationStatus': 'connected'|'pending-resync'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string',
'IsDataLossAllowed': True|False
},
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.
(string) --
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
SynchronizationStatus (string) --
The status of synchronization of each Amazon DocumentDB cluster in the global cluster.
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. 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 cluster and the specified secondary cluster are being verified before the operation starts.
failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB 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.
TagList (list) --
A list of global cluster tags.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'IsDataLossAllowed': 'boolean',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'},
'GlobalClusterMembers': {'SynchronizationStatus': 'connected '
'| '
'pending-resync'},
'TagList': [{'Key': 'string', 'Value': 'string'}]}}
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
See also: AWS API Documentation
Request Syntax
client.delete_global_cluster(
GlobalClusterIdentifier='string'
)
string
[REQUIRED]
The cluster identifier of the global cluster being deleted.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'SynchronizationStatus': 'connected'|'pending-resync'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string',
'IsDataLossAllowed': True|False
},
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.
(string) --
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
SynchronizationStatus (string) --
The status of synchronization of each Amazon DocumentDB cluster in the global cluster.
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. 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 cluster and the specified secondary cluster are being verified before the operation starts.
failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB 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.
TagList (list) --
A list of global cluster tags.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
{'GlobalClusters': {'FailoverState': {'FromDbClusterArn': 'string',
'IsDataLossAllowed': 'boolean',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'},
'GlobalClusterMembers': {'SynchronizationStatus': 'connected '
'| '
'pending-resync'},
'TagList': [{'Key': 'string', 'Value': 'string'}]}}
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
See also: AWS API Documentation
Request Syntax
client.describe_global_clusters(
GlobalClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.
list
A filter that specifies one or more global DB clusters to describe.
Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.
(dict) --
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
string
An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
dict
Response Syntax
{
'Marker': 'string',
'GlobalClusters': [
{
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'SynchronizationStatus': 'connected'|'pending-resync'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string',
'IsDataLossAllowed': True|False
},
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Marker (string) --
GlobalClusters (list) --
(dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.
(string) --
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
SynchronizationStatus (string) --
The status of synchronization of each Amazon DocumentDB cluster in the global cluster.
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. 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 cluster and the specified secondary cluster are being verified before the operation starts.
failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB 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.
TagList (list) --
A list of global cluster tags.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'IsDataLossAllowed': 'boolean',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'},
'GlobalClusterMembers': {'SynchronizationStatus': 'connected '
'| '
'pending-resync'},
'TagList': [{'Key': 'string', 'Value': 'string'}]}}
Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.
Use this operation to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
See also: AWS API Documentation
Request Syntax
client.failover_global_cluster(
GlobalClusterIdentifier='string',
TargetDbClusterIdentifier='string',
AllowDataLoss=True|False,
Switchover=True|False
)
string
[REQUIRED]
The identifier of the Amazon DocumentDB global cluster to apply this operation. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster.
Constraints:
Must match the identifier of an existing global cluster.
Minimum length of 1. Maximum length of 255.
Pattern: [A-Za-z][0-9A-Za-z-:._]*
string
[REQUIRED]
The identifier of the secondary Amazon DocumentDB cluster that you want to promote to the primary for the global cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.
Constraints:
Must match the identifier of an existing secondary cluster.
Minimum length of 1. Maximum length of 255.
Pattern: [A-Za-z][0-9A-Za-z-:._]*
boolean
Specifies whether to allow data loss for this global cluster operation. Allowing data loss triggers a global failover operation.
If you don't specify AllowDataLoss, the global 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',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'SynchronizationStatus': 'connected'|'pending-resync'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string',
'IsDataLossAllowed': True|False
},
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.
(string) --
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
SynchronizationStatus (string) --
The status of synchronization of each Amazon DocumentDB cluster in the global cluster.
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. 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 cluster and the specified secondary cluster are being verified before the operation starts.
failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB 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.
TagList (list) --
A list of global cluster tags.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'IsDataLossAllowed': 'boolean',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'},
'GlobalClusterMembers': {'SynchronizationStatus': 'connected '
'| '
'pending-resync'},
'TagList': [{'Key': 'string', 'Value': 'string'}]}}
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
See also: AWS API Documentation
Request Syntax
client.modify_global_cluster(
GlobalClusterIdentifier='string',
NewGlobalClusterIdentifier='string',
DeletionProtection=True|False
)
string
[REQUIRED]
The identifier for the global cluster being modified. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing global cluster.
string
The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.
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 if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'SynchronizationStatus': 'connected'|'pending-resync'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string',
'IsDataLossAllowed': True|False
},
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.
(string) --
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
SynchronizationStatus (string) --
The status of synchronization of each Amazon DocumentDB cluster in the global cluster.
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. 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 cluster and the specified secondary cluster are being verified before the operation starts.
failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB 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.
TagList (list) --
A list of global cluster tags.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'IsDataLossAllowed': 'boolean',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'},
'GlobalClusterMembers': {'SynchronizationStatus': 'connected '
'| '
'pending-resync'},
'TagList': [{'Key': 'string', 'Value': 'string'}]}}
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
See also: AWS API Documentation
Request Syntax
client.remove_from_global_cluster(
GlobalClusterIdentifier='string',
DbClusterIdentifier='string'
)
string
[REQUIRED]
The cluster identifier to detach from the Amazon DocumentDB global cluster.
string
[REQUIRED]
The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'SynchronizationStatus': 'connected'|'pending-resync'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string',
'IsDataLossAllowed': True|False
},
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.
(string) --
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
SynchronizationStatus (string) --
The status of synchronization of each Amazon DocumentDB cluster in the global cluster.
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. 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 cluster and the specified secondary cluster are being verified before the operation starts.
failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB 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.
TagList (list) --
A list of global cluster tags.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'IsDataLossAllowed': 'boolean',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'},
'GlobalClusterMembers': {'SynchronizationStatus': 'connected '
'| '
'pending-resync'},
'TagList': [{'Key': 'string', 'Value': 'string'}]}}
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
See also: AWS API Documentation
Request Syntax
client.switchover_global_cluster(
GlobalClusterIdentifier='string',
TargetDbClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DocumentDB global database cluster to switch over. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster. This parameter isn’t case-sensitive.
Constraints:
Must match the identifier of an existing global cluster (Amazon DocumentDB global database).
Minimum length of 1. Maximum length of 255.
Pattern: [A-Za-z][0-9A-Za-z-:._]*
string
[REQUIRED]
The identifier of the secondary Amazon DocumentDB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.
Constraints:
Must match the identifier of an existing secondary cluster.
Minimum length of 1. Maximum length of 255.
Pattern: [A-Za-z][0-9A-Za-z-:._]*
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'SynchronizationStatus': 'connected'|'pending-resync'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string',
'IsDataLossAllowed': True|False
},
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.
(string) --
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
SynchronizationStatus (string) --
The status of synchronization of each Amazon DocumentDB cluster in the global cluster.
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. 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 cluster and the specified secondary cluster are being verified before the operation starts.
failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Amazon DocumentDB 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.
TagList (list) --
A list of global cluster tags.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").