CfnGlobalClusterProps

class aws_cdk.aws_rds.CfnGlobalClusterProps(*, deletion_protection=None, engine=None, engine_version=None, global_cluster_identifier=None, source_db_cluster_identifier=None, storage_encrypted=None)

Bases: object

Properties for defining a CfnGlobalCluster.

Parameters:

  • deletion_protection (Union[bool, IResolvable, None]) – 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 (Optional[str]) – 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.

  • engine_version (Optional[str]) – 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.

  • global_cluster_identifier (Optional[str]) – The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

  • source_db_cluster_identifier (Optional[str]) – 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

  • storage_encrypted (Union[bool, IResolvable, None]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

cfn_global_cluster_props = rds.CfnGlobalClusterProps(
    deletion_protection=False,
    engine="engine",
    engine_version="engineVersion",
    global_cluster_identifier="globalClusterIdentifier",
    source_db_cluster_identifier="sourceDbClusterIdentifier",
    storage_encrypted=False
)

Attributes

deletion_protection

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:

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

engine

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:

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

engine_version

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:

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

global_cluster_identifier

The cluster identifier for this global database cluster.

This parameter is stored as a lowercase string.

See:

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

source_db_cluster_identifier

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:

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

storage_encrypted

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:

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