L1 ConstructAWS::RDS::GlobalCluster

CfnGlobalCluster

The `AWS::RDS::GlobalCluster` resource creates or updates an Amazon 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. For information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide* .

Import

import { CfnGlobalCluster } from 'aws-cdk-lib/aws-rds';

Or use the module namespace:

import * as rds from 'aws-cdk-lib/aws-rds';
// rds.CfnGlobalCluster

Properties

Configuration passed to the constructor as CfnGlobalClusterProps.

deletionProtectionOptional

boolean | IResolvable

Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.

engineOptional

string

The database engine to use for this global database cluster. Valid Values: `aurora-mysql | aurora-postgresql` Constraints: - Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

engineLifecycleSupportOptional

string

The life cycle type for this global database cluster. > By default, this value is set to `open-source-rds-extended-support` , which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled` . In this case, creating the global cluster will fail if the DB major version is past its end of standard support date. This setting only applies to Aurora PostgreSQL-based global databases. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* . Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled` Default: `open-source-rds-extended-support`

engineVersionOptional

string

The engine version to use for this global database cluster. Constraints: - Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

globalClusterIdentifierOptional

string

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

sourceDbClusterIdentifierOptional

string | IDBClusterRef

The Amazon Resource Name (ARN) to use as the primary cluster of the global database. If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster: - `DatabaseName` - `Engine` - `EngineVersion` - `StorageEncrypted`

storageEncryptedOptional

boolean | IResolvable

Specifies whether to enable storage encryption for the new global database cluster. Constraints: - Can't be specified if `SourceDBClusterIdentifier` is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

tagsOptional

CfnTag[]

Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide* .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::RDS::GlobalClusterView in CloudFormation Explorer

Get the Amazon RDS Cheat Sheet

Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)

Moduleaws-rds

CFN TypeAWS::RDS::GlobalCluster

Properties8

Related Constructs

Explore This Service

External Links

CDK API Documentation