CfnGlobalClusterPropsMixin

class aws_cdk.cfn_property_mixins.aws_rds.CfnGlobalClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::RDS::GlobalCluster resource creates or updates an Amazon Aurora global database spread across multiple AWS Regions.

The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it.

For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .

See:

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

CloudformationResource:

AWS::RDS::GlobalCluster

Mixin:

true

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.cfn_property_mixins import aws_rds as rds
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_global_cluster_props_mixin = rds.CfnGlobalClusterPropsMixin(rds.CfnGlobalClusterMixinProps(
    deletion_protection=False,
    engine="engine",
    engine_lifecycle_support="engineLifecycleSupport",
    engine_version="engineVersion",
    global_cluster_identifier="globalClusterIdentifier",
    source_db_cluster_identifier="sourceDbClusterIdentifier",
    storage_encrypted=False,
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::RDS::GlobalCluster.

Parameters:
  • props (Union[CfnGlobalClusterMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['deletionProtection', 'engine', 'engineLifecycleSupport', 'engineVersion', 'globalClusterIdentifier', 'sourceDbClusterIdentifier', 'storageEncrypted', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

GlobalEndpointProperty

class CfnGlobalClusterPropsMixin.GlobalEndpointProperty(*, address=None)

Bases: object

The writer endpoint for the new global database cluster.

This endpoint always points to the writer DB instance in the current primary cluster.

Parameters:

address (Optional[str]) – The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-globalcluster-globalendpoint.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.cfn_property_mixins import aws_rds as rds

global_endpoint_property = rds.CfnGlobalClusterPropsMixin.GlobalEndpointProperty(
    address="address"
)

Attributes

address

The writer endpoint for the new global database cluster.

This endpoint always points to the writer DB instance in the current primary cluster.

See:

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