CfnGlobalReplicationGroupPropsMixin

class aws_cdk.cfn_property_mixins.aws_elasticache.CfnGlobalReplicationGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.

The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html
CloudformationResource:: AWS::ElastiCache::GlobalReplicationGroup
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_elasticache as elasticache
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_global_replication_group_props_mixin = elasticache.CfnGlobalReplicationGroupPropsMixin(elasticache.CfnGlobalReplicationGroupMixinProps(
    automatic_failover_enabled=False,
    cache_node_type="cacheNodeType",
    cache_parameter_group_name="cacheParameterGroupName",
    engine="engine",
    engine_version="engineVersion",
    global_node_group_count=123,
    global_replication_group_description="globalReplicationGroupDescription",
    global_replication_group_id_suffix="globalReplicationGroupIdSuffix",
    members=[elasticache.CfnGlobalReplicationGroupPropsMixin.GlobalReplicationGroupMemberProperty(
        replication_group_id="replicationGroupId",
        replication_group_region="replicationGroupRegion",
        role="role"
    )],
    regional_configurations=[elasticache.CfnGlobalReplicationGroupPropsMixin.RegionalConfigurationProperty(
        replication_group_id="replicationGroupId",
        replication_group_region="replicationGroupRegion",
        resharding_configurations=[elasticache.CfnGlobalReplicationGroupPropsMixin.ReshardingConfigurationProperty(
            node_group_id="nodeGroupId",
            preferred_availability_zones=["preferredAvailabilityZones"]
        )]
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::ElastiCache::GlobalReplicationGroup.

Parameters:

props (Union[CfnGlobalReplicationGroupMixinProps, 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 = ['automaticFailoverEnabled', 'cacheNodeType', 'cacheParameterGroupName', 'engine', 'engineVersion', 'globalNodeGroupCount', 'globalReplicationGroupDescription', 'globalReplicationGroupIdSuffix', 'members', 'regionalConfigurations']

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.

GlobalReplicationGroupMemberProperty

class CfnGlobalReplicationGroupPropsMixin.GlobalReplicationGroupMemberProperty(*, replication_group_id=None, replication_group_region=None, role=None)

Bases: object

A member of a Global datastore.

It contains the Replication Group Id, the Amazon region and the role of the replication group.

Parameters:

replication_group_id (Optional[str]) – The replication group id of the Global datastore member.
replication_group_region (Optional[str]) – The Amazon region of the Global datastore member.
role (Optional[str]) – Indicates the role of the replication group, PRIMARY or SECONDARY .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.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_elasticache as elasticache

global_replication_group_member_property = elasticache.CfnGlobalReplicationGroupPropsMixin.GlobalReplicationGroupMemberProperty(
    replication_group_id="replicationGroupId",
    replication_group_region="replicationGroupRegion",
    role="role"
)

Attributes

replication_group_id

The replication group id of the Global datastore member.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupid

replication_group_region

The Amazon region of the Global datastore member.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupregion

role

Indicates the role of the replication group, PRIMARY or SECONDARY .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-role

RegionalConfigurationProperty

class CfnGlobalReplicationGroupPropsMixin.RegionalConfigurationProperty(*, replication_group_id=None, replication_group_region=None, resharding_configurations=None)

Bases: object

A list of the replication groups.

Parameters:

replication_group_id (Optional[str]) – The name of the secondary cluster.
replication_group_region (Optional[str]) – The Amazon region where the cluster is stored.
resharding_configurations (Union[IResolvable, Sequence[Union[IResolvable, ReshardingConfigurationProperty, Dict[str, Any]]], None]) – A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.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_elasticache as elasticache

regional_configuration_property = elasticache.CfnGlobalReplicationGroupPropsMixin.RegionalConfigurationProperty(
    replication_group_id="replicationGroupId",
    replication_group_region="replicationGroupRegion",
    resharding_configurations=[elasticache.CfnGlobalReplicationGroupPropsMixin.ReshardingConfigurationProperty(
        node_group_id="nodeGroupId",
        preferred_availability_zones=["preferredAvailabilityZones"]
    )]
)

Attributes

replication_group_id

The name of the secondary cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupid

replication_group_region

The Amazon region where the cluster is stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupregion

resharding_configurations

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-reshardingconfigurations

ReshardingConfigurationProperty

class CfnGlobalReplicationGroupPropsMixin.ReshardingConfigurationProperty(*, node_group_id=None, preferred_availability_zones=None)

Bases: object

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

Parameters:

node_group_id (Optional[str]) – Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
preferred_availability_zones (Optional[Sequence[str]]) – A list of preferred availability zones for the nodes in this cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.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_elasticache as elasticache

resharding_configuration_property = elasticache.CfnGlobalReplicationGroupPropsMixin.ReshardingConfigurationProperty(
    node_group_id="nodeGroupId",
    preferred_availability_zones=["preferredAvailabilityZones"]
)

Attributes

node_group_id

Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-nodegroupid

preferred_availability_zones

A list of preferred availability zones for the nodes in this cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-preferredavailabilityzones