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]) – The deletion protection setting for the new global database. The global database can’t be deleted when deletion protection is enabled.

  • engine (Optional[str]) – 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. .. epigraph:: If the SourceDBClusterIdentifier property isn’t specified, this property is required. If the SourceDBClusterIdentifier property is specified, make sure this property isn’t specified.

  • engine_version (Optional[str]) – The engine version of the Aurora global database.

  • global_cluster_identifier (Optional[str]) – The cluster identifier of the global database cluster.

  • source_db_cluster_identifier (Optional[str]) – The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database. .. epigraph:: If the Engine property isn’t specified, this property is required. If the Engine property is specified, make sure this property isn’t specified.

  • storage_encrypted (Union[bool, IResolvable, None]) – The storage encryption setting for the global database cluster.

Link

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.
import aws_cdk.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

The deletion protection setting for the new global database.

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

Link

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

Return type

Union[bool, IResolvable, None]

engine

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. .. epigraph:

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

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

Return type

Optional[str]

engine_version

The engine version of the Aurora global database.

Link

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

Return type

Optional[str]

global_cluster_identifier

The cluster identifier of the global database cluster.

Link

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

Return type

Optional[str]

source_db_cluster_identifier

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.

Link

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

Return type

Optional[str]

storage_encrypted

The storage encryption setting for the global database cluster.

Link

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

Return type

Union[bool, IResolvable, None]