interface CfnGlobalClusterProps

Language	Type name
.NET	Amazon.CDK.AWS.RDS.CfnGlobalClusterProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnGlobalClusterProps
Java	software.amazon.awscdk.services.rds.CfnGlobalClusterProps
Python	aws_cdk.aws_rds.CfnGlobalClusterProps
TypeScript	aws-cdk-lib » aws_rds » CfnGlobalClusterProps

Properties for defining a CfnGlobalCluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnGlobalClusterProps: rds.CfnGlobalClusterProps = {
  deletionProtection: false,
  engine: 'engine',
  engineLifecycleSupport: 'engineLifecycleSupport',
  engineVersion: 'engineVersion',
  globalClusterIdentifier: 'globalClusterIdentifier',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  storageEncrypted: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
deletionProtection?	boolean | IResolvable	Specifies whether to enable deletion protection for the new global database cluster.
engine?	string	The database engine to use for this global database cluster.
engineLifecycleSupport?	string	The life cycle type for this global database cluster.
engineVersion?	string	The engine version to use for this global database cluster.
globalClusterIdentifier?	string	The cluster identifier for this global database cluster.
sourceDbClusterIdentifier?	string	The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
storageEncrypted?	boolean | IResolvable	Specifies whether to enable storage encryption for the new global database cluster.
tags?	CfnTag[]	Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

---

deletionProtection?

Type: boolean | IResolvable (optional)

Specifies whether to enable deletion protection for the new global database cluster.

The global database can't be deleted when deletion protection is enabled.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-deletionprotection

---

engine?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engine

---

engineLifecycleSupport?

Type: string (optional)

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 Using Amazon RDS Extended Support 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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-enginelifecyclesupport

---

engineVersion?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engineversion

---

globalClusterIdentifier?

Type: string (optional)

The cluster identifier for this global database cluster.

This parameter is stored as a lowercase string.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-globalclusteridentifier

---

sourceDbClusterIdentifier?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-sourcedbclusteridentifier

---

storageEncrypted?

Type: boolean | IResolvable (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-storageencrypted

---

tags?

Type: CfnTag[] (optional)

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-tags