Skip to content

Modify Global Cluster

rds_modify_global_cluster R Documentation

Modifies a setting for an Amazon Aurora global database cluster

Description

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.

This operation only applies to Aurora global database clusters.

Usage

rds_modify_global_cluster(GlobalClusterIdentifier,
  NewGlobalClusterIdentifier, DeletionProtection, EngineVersion,
  AllowMajorVersionUpgrade)

Arguments

GlobalClusterIdentifier

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

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

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

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

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.

Value

A list with the following syntax: 

list(
  GlobalCluster = list(
    GlobalClusterIdentifier = "string",
    GlobalClusterResourceId = "string",
    GlobalClusterArn = "string",
    Status = "string",
    Engine = "string",
    EngineVersion = "string",
    EngineLifecycleSupport = "string",
    DatabaseName = "string",
    StorageEncrypted = TRUE|FALSE,
    DeletionProtection = TRUE|FALSE,
    GlobalClusterMembers = list(
      list(
        DBClusterArn = "string",
        Readers = list(
          "string"
        ),
        IsWriter = TRUE|FALSE,
        GlobalWriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"unknown",
        SynchronizationStatus = "connected"|"pending-resync"
      )
    ),
    FailoverState = list(
      Status = "pending"|"failing-over"|"cancelling",
      FromDbClusterArn = "string",
      ToDbClusterArn = "string",
      IsDataLossAllowed = TRUE|FALSE
    )
  )
)

Request syntax

svc$modify_global_cluster(
  GlobalClusterIdentifier = "string",
  NewGlobalClusterIdentifier = "string",
  DeletionProtection = TRUE|FALSE,
  EngineVersion = "string",
  AllowMajorVersionUpgrade = TRUE|FALSE
)