CfnGlobalClusterMixinProps

class aws_cdk.mixins_preview.aws_docdb.mixins.CfnGlobalClusterMixinProps(*, deletion_protection=None, engine=None, engine_version=None, global_cluster_identifier=None, source_db_cluster_identifier=None, storage_encrypted=None, tags=None)

Bases: object

Properties for CfnGlobalClusterPropsMixin.

Parameters:

  • deletion_protection (Union[bool, IResolvable, None]) – Indicates whether the global cluster has deletion protection enabled. The global cluster can’t be deleted when deletion protection is enabled.

  • engine (Optional[str]) – The database engine to use for this global cluster. Default: - “docdb”

  • engine_version (Optional[str]) – The engine version to use for this global cluster.

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

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

  • storage_encrypted (Union[bool, IResolvable, None]) – Indicates whether the global cluster has storage encryption enabled.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to be assigned to the Amazon DocumentDB resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_docdb import mixins as docdb_mixins

cfn_global_cluster_mixin_props = docdb_mixins.CfnGlobalClusterMixinProps(
    deletion_protection=False,
    engine="engine",
    engine_version="engineVersion",
    global_cluster_identifier="globalClusterIdentifier",
    source_db_cluster_identifier="sourceDbClusterIdentifier",
    storage_encrypted=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

deletion_protection

Indicates whether the global cluster has deletion protection enabled.

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

See:

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

engine

The database engine to use for this global cluster.

Default:

  • “docdb”

See:

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

engine_version

The engine version to use for this global cluster.

See:

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

global_cluster_identifier

The cluster identifier of the global cluster.

See:

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

source_db_cluster_identifier

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:

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

storage_encrypted

Indicates whether the global cluster has storage encryption enabled.

See:

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

tags

The tags to be assigned to the Amazon DocumentDB resource.

See:

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