RDS / Client / modify_global_cluster

modify_global_cluster#

RDS.Client.modify_global_cluster(**kwargs)#

Modifies a setting for an Amazon Aurora global database 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 operation only applies to Aurora global database clusters.

Request Syntax

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

Parameters:

GlobalClusterIdentifier (string) –
The cluster identifier for the global cluster to modify. 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. 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) – Specifies whether to enable deletion protection for the global database cluster. 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.

To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), 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 (for PostgreSQL-based Aurora global databases), use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
AllowMajorVersionUpgrade (boolean) –
Specifies whether to allow major version upgrades.

Constraints: Must be enabled if you specify a value for the EngineVersion parameter that’s a different major version than the global 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',
                'SynchronizationStatus': 'connected'|'pending-resync'
            },
        ],
        'FailoverState': {
            'Status': 'pending'|'failing-over'|'cancelling',
            'FromDbClusterArn': 'string',
            'ToDbClusterArn': 'string',
            'IsDataLossAllowed': True|False
        }
    }
}

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 a global cluster (Aurora global database).
      - DBClusterArn (string) –
        
        The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
      - Readers (list) –
        
        The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.
        
        (string) –
      - IsWriter (boolean) –
        
        Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
      - GlobalWriteForwardingStatus (string) –
        
        The status of write forwarding for a secondary cluster in the global cluster.
      - SynchronizationStatus (string) –
        
        The status of synchronization of each Aurora DB 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 (Aurora 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 – This status covers the range of Aurora internal operations that take place during the switchover or failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.
      - cancelling – The request to switch over or fail over the global cluster 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.
    - 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.

Exceptions

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