interface CfnGlobalClusterProps

Language	Type name
.NET	Amazon.CDK.AWS.DocDB.CfnGlobalClusterProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#CfnGlobalClusterProps
Java	software.amazon.awscdk.services.docdb.CfnGlobalClusterProps
Python	aws_cdk.aws_docdb.CfnGlobalClusterProps
TypeScript	aws-cdk-lib » aws_docdb » CfnGlobalClusterProps

Properties for defining a CfnGlobalCluster.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_docdb as docdb } from 'aws-cdk-lib';
const cfnGlobalClusterProps: docdb.CfnGlobalClusterProps = {
  globalClusterIdentifier: 'globalClusterIdentifier',

  // the properties below are optional
  deletionProtection: false,
  engine: 'engine',
  engineVersion: 'engineVersion',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  storageEncrypted: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
globalClusterIdentifier	string	The cluster identifier of the global cluster.
deletionProtection?	boolean | IResolvable	Indicates whether the global cluster has deletion protection enabled.
engine?	string	The database engine to use for this global cluster.
engineVersion?	string	The engine version to use for this global cluster.
sourceDbClusterIdentifier?	string	The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.
storageEncrypted?	boolean | IResolvable	Indicates whether the global cluster has storage encryption enabled.
tags?	CfnTag[]	The tags to be assigned to the Amazon DocumentDB resource.

---

globalClusterIdentifier

Type: string

The cluster identifier of the global cluster.

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

---

deletionProtection?

Type: boolean | IResolvable (optional)

Indicates whether the global cluster has deletion protection enabled.

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

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

---

engine?

Type: string (optional, default: "docdb")

The database engine to use for this global cluster.

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

---

engineVersion?

Type: string (optional)

The engine version to use for this global cluster.

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

---

sourceDbClusterIdentifier?

Type: string (optional)

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

You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted

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

---

storageEncrypted?

Type: boolean | IResolvable (optional)

Indicates whether the global cluster has storage encryption enabled.

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

---

tags?

Type: CfnTag[] (optional)

The tags to be assigned to the Amazon DocumentDB resource.

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