aws-cdk-lib.aws_rds.CfnGlobalClusterProps

interface CfnGlobalClusterProps

LanguageType name
.NETAmazon.CDK.AWS.RDS.CfnGlobalClusterProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnGlobalClusterProps
Javasoftware.amazon.awscdk.services.rds.CfnGlobalClusterProps
Pythonaws_cdk.aws_rds.CfnGlobalClusterProps
TypeScript aws-cdk-lib » aws_rds » CfnGlobalClusterProps

Properties for defining a CfnGlobalCluster.

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',
  engineVersion: 'engineVersion',
  globalClusterIdentifier: 'globalClusterIdentifier',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  storageEncrypted: false,
};

Properties

NameTypeDescription
deletionProtection?boolean | IResolvableThe deletion protection setting for the new global database.
engine?stringThe name of the database engine to be used for this DB cluster.
engineVersion?stringThe engine version of the Aurora global database.
globalClusterIdentifier?stringThe cluster identifier of the global database cluster.
sourceDbClusterIdentifier?stringThe DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.
storageEncrypted?boolean | IResolvableThe storage encryption setting for the global database cluster.

deletionProtection?

Type: boolean | IResolvable (optional)

The deletion protection setting for the new global database.

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


engine?

Type: string (optional)

The name of the database engine to be used for this DB cluster.

If this property isn't specified, the database engine is derived from the source DB cluster specified by the SourceDBClusterIdentifier property.

If the SourceDBClusterIdentifier property isn't specified, this property is required. If the SourceDBClusterIdentifier property is specified, make sure this property isn't specified.


engineVersion?

Type: string (optional)

The engine version of the Aurora global database.


globalClusterIdentifier?

Type: string (optional)

The cluster identifier of the global database cluster.


sourceDbClusterIdentifier?

Type: string (optional)

The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.

If the Engine property isn't specified, this property is required. If the Engine property is specified, make sure this property isn't specified.


storageEncrypted?

Type: boolean | IResolvable (optional)

The storage encryption setting for the global database cluster.