Neptune / Client / modify_global_cluster

modify_global_cluster

Neptune.Client.modify_global_cluster(**kwargs)

Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• GlobalClusterIdentifier (string) –

  [REQUIRED]

  The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

  Constraints: Must match the identifier of an existing global database cluster.

• NewGlobalClusterIdentifier (string) –

  A new cluster identifier to assign to the global database. This value is stored as a lowercase string.

  Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Can’t end with a hyphen or contain two consecutive hyphens

  Example: my-cluster2

• DeletionProtection (boolean) – Indicates whether the global database has deletion protection enabled. The global database cannot 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 will result in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

  To list all of the available Neptune engine versions, use the following command:

• AllowMajorVersionUpgrade (boolean) –

  A value that indicates whether major version upgrades are allowed.

  Constraints: You must allow major version upgrades if you specify a value for the EngineVersion parameter that is a different major version than the DB cluster’s current version.

  If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.

Return type:

dict

Returns:

Response Syntax

{
    'GlobalCluster': {
        'GlobalClusterIdentifier': 'string',
        'GlobalClusterResourceId': 'string',
        'GlobalClusterArn': 'string',
        'Status': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'StorageEncrypted': True|False,
        'DeletionProtection': True|False,
        'GlobalClusterMembers': [
            {
                'DBClusterArn': 'string',
                'Readers': [
                    'string',
                ],
                'IsWriter': True|False
            },
        ]
    }
}

Response Structure

• (dict) –

  • GlobalCluster (dict) –

    Contains the details of an Amazon Neptune global database.

    This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

    • GlobalClusterIdentifier (string) –

      Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

    • GlobalClusterResourceId (string) –

      An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

    • GlobalClusterArn (string) –

      The Amazon Resource Name (ARN) for the global database.

    • Status (string) –

      Specifies the current state of this global database.

    • Engine (string) –

      The Neptune database engine used by the global database ( "neptune").

    • EngineVersion (string) –

      The Neptune engine version used by the global database.

    • StorageEncrypted (boolean) –

      The storage encryption setting for the global database.

    • DeletionProtection (boolean) –

      The deletion protection setting for the global database.

    • GlobalClusterMembers (list) –

      A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

      • (dict) –

        A data structure with information about any primary and secondary clusters associated with an Neptune global database.

        • DBClusterArn (string) –

          The Amazon Resource Name (ARN) for each Neptune cluster.

        • Readers (list) –

          The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.

          • (string) –

        • IsWriter (boolean) –

          Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.

Exceptions

• Neptune.Client.exceptions.GlobalClusterNotFoundFault

• Neptune.Client.exceptions.InvalidGlobalClusterStateFault