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',
engineVersion: 'engineVersion',
globalClusterIdentifier: 'globalClusterIdentifier',
sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
storageEncrypted: false,
};
Properties
Name | Type | Description |
---|---|---|
deletion | 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. |
engine | string | The engine version to use for this global database cluster. |
global | string | The cluster identifier for this global database cluster. |
source | string | The Amazon Resource Name (ARN) to use as the primary cluster of the global database. |
storage | boolean | IResolvable | Specifies whether to enable storage encryption for the new global database cluster. |
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.
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.
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.
globalClusterIdentifier?
Type:
string
(optional)
The cluster identifier for this global database cluster.
This parameter is stored as a lowercase string.
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
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.