CfnGlobalClusterProps

class aws_cdk.aws_rds.CfnGlobalClusterProps(*, deletion_protection=None, engine=None, engine_lifecycle_support=None, engine_version=None, global_cluster_identifier=None, global_endpoint=None, source_db_cluster_identifier=None, storage_encrypted=None, tags=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_lifecycle_support (Optional[str]) – The life cycle type for this global database cluster. .. epigraph:: By default, this value is set to open-source-rds-extended-support , which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled . In this case, creating the global cluster will fail if the DB major version is past its end of standard support date. This setting only applies to Aurora PostgreSQL-based global databases. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide . Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
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.
global_endpoint (Union[IResolvable, GlobalEndpointProperty, Dict[str, Any], None]) –
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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide .

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_lifecycle_support="engineLifecycleSupport",
    engine_version="engineVersion",
    global_cluster_identifier="globalClusterIdentifier",
    global_endpoint=rds.CfnGlobalCluster.GlobalEndpointProperty(
        address="address"
    ),
    source_db_cluster_identifier="sourceDbClusterIdentifier",
    storage_encrypted=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

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_lifecycle_support

The life cycle type for this global database cluster.

By default, this value is set to open-source-rds-extended-support , which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled . In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.

This setting only applies to Aurora PostgreSQL-based global databases.

You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide .

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

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

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

global_endpoint

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

Type:: see

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

tags

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide .

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