2021/02/11 - Amazon Relational Database Service - 1 new 5 updated api methods
Changes Adding support for RDS Aurora Global Database Failover Support cross-region copying in DocDB and Neptune
Initiates the failover process for an Aurora global database ( GlobalCluster ).
A failover for an Aurora 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) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.
For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.
Note
This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.
See also: AWS API Documentation
Request Syntax
client.failover_global_cluster(
GlobalClusterIdentifier='string',
TargetDbClusterIdentifier='string'
)
string
[REQUIRED]
Identifier of the Aurora global database ( GlobalCluster ) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.
Constraints:
Must match the identifier of an existing GlobalCluster (Aurora global database).
string
[REQUIRED]
Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database ( GlobalCluster .) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its AWS Region.
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,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
(string) --
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
pending – A request to fail over the Aurora global database ( GlobalCluster ) has been received by the service. The GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling – The request to fail over the Aurora global database ( GlobalCluster ) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'}}}
Creates an Aurora global database spread across multiple AWS Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
Note
This action only applies to Aurora DB clusters.
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
The cluster identifier of the new global database cluster.
string
The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.
string
The name of the database engine to be used for this DB cluster.
string
The engine version of the Aurora global database.
boolean
The deletion protection setting for the new global database. The global database 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 Aurora will not create a database in the global database cluster you are creating.
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',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
(string) --
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
pending – A request to fail over the Aurora global database ( GlobalCluster ) has been received by the service. The GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling – The request to fail over the Aurora global database ( GlobalCluster ) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'}}}
Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
Note
This action only applies to Aurora DB clusters.
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',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
(string) --
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
pending – A request to fail over the Aurora global database ( GlobalCluster ) has been received by the service. The GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling – The request to fail over the Aurora global database ( GlobalCluster ) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
{'GlobalClusters': {'FailoverState': {'FromDbClusterArn': 'string',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'}}}
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB clusters.
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 DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DBClusterIdentifier.
list
A filter that specifies one or more global DB clusters to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
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.
Default: 100
Constraints: Minimum 20, maximum 100.
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,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (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 .
GlobalClusters (list) --
The list of global clusters returned by this request.
(dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
(string) --
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
pending – A request to fail over the Aurora global database ( GlobalCluster ) has been received by the service. The GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling – The request to fail over the Aurora global database ( GlobalCluster ) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'}}}
Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
client.modify_global_cluster(
GlobalClusterIdentifier='string',
NewGlobalClusterIdentifier='string',
DeletionProtection=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False
)
string
The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
string
The new cluster identifier for the global database cluster when modifying a global database cluster. 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 if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.
string
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql , use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
boolean
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying 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. 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',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
(string) --
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
pending – A request to fail over the Aurora global database ( GlobalCluster ) has been received by the service. The GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling – The request to fail over the Aurora global database ( GlobalCluster ) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
{'GlobalCluster': {'FailoverState': {'FromDbClusterArn': 'string',
'Status': 'pending | failing-over | '
'cancelling',
'ToDbClusterArn': 'string'}}}
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
client.remove_from_global_cluster(
GlobalClusterIdentifier='string',
DbClusterIdentifier='string'
)
string
The cluster identifier to detach from the Aurora global database cluster.
string
The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database 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,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
(string) --
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
pending – A request to fail over the Aurora global database ( GlobalCluster ) has been received by the service. The GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling – The request to fail over the Aurora global database ( GlobalCluster ) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.