RDS / Client / modify_global_cluster

modify_global_cluster#

RDS.Client.modify_global_cluster(**kwargs)#

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

response = client.modify_global_cluster(
    GlobalClusterIdentifier='string',
    NewGlobalClusterIdentifier='string',
    DeletionProtection=True|False,
    EngineVersion='string',
    AllowMajorVersionUpgrade=True|False
)

Parameters:

GlobalClusterIdentifier (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.
NewGlobalClusterIdentifier (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
DeletionProtection (boolean) – Indicates if the global database cluster has deletion protection enabled. The global database cluster can’t be deleted when deletion protection is enabled.
EngineVersion (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 and MySQL 8.0-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]'
AllowMajorVersionUpgrade (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.

Return type:

dict

Returns:

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 Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key 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 primary and secondary clusters within the global database cluster.
    - (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.

Exceptions

RDS.Client.exceptions.GlobalClusterNotFoundFault
RDS.Client.exceptions.InvalidGlobalClusterStateFault
RDS.Client.exceptions.InvalidDBClusterStateFault
RDS.Client.exceptions.InvalidDBInstanceStateFault