CfnGlobalReplicationGroupProps

class aws_cdk.aws_elasticache.CfnGlobalReplicationGroupProps(*, members, automatic_failover_enabled=None, cache_node_type=None, cache_parameter_group_name=None, engine_version=None, global_node_group_count=None, global_replication_group_description=None, global_replication_group_id_suffix=None, regional_configurations=None)

Bases: object

Properties for defining a CfnGlobalReplicationGroup.

Parameters
  • members (Union[IResolvable, Sequence[Union[IResolvable, GlobalReplicationGroupMemberProperty, Dict[str, Any]]]]) – The replication groups that comprise the Global datastore.

  • automatic_failover_enabled (Union[bool, IResolvable, None]) – Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

  • cache_node_type (Optional[str]) – The cache node type of the Global datastore.

  • cache_parameter_group_name (Optional[str]) – The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

  • engine_version (Optional[str]) – The Elasticache Redis engine version.

  • global_node_group_count (Union[int, float, None]) – The number of node groups that comprise the Global Datastore.

  • global_replication_group_description (Optional[str]) – The optional description of the Global datastore.

  • global_replication_group_id_suffix (Optional[str]) – The suffix name of a Global Datastore. The suffix guarantees uniqueness of the Global Datastore name across multiple regions.

  • regional_configurations (Union[IResolvable, Sequence[Union[IResolvable, RegionalConfigurationProperty, Dict[str, Any]]], None]) – The Amazon Regions that comprise the Global Datastore.

Link

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

cfn_global_replication_group_props = elasticache.CfnGlobalReplicationGroupProps(
    members=[elasticache.CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty(
        replication_group_id="replicationGroupId",
        replication_group_region="replicationGroupRegion",
        role="role"
    )],

    # the properties below are optional
    automatic_failover_enabled=False,
    cache_node_type="cacheNodeType",
    cache_parameter_group_name="cacheParameterGroupName",
    engine_version="engineVersion",
    global_node_group_count=123,
    global_replication_group_description="globalReplicationGroupDescription",
    global_replication_group_id_suffix="globalReplicationGroupIdSuffix",
    regional_configurations=[elasticache.CfnGlobalReplicationGroup.RegionalConfigurationProperty(
        replication_group_id="replicationGroupId",
        replication_group_region="replicationGroupRegion",
        resharding_configurations=[elasticache.CfnGlobalReplicationGroup.ReshardingConfigurationProperty(
            node_group_id="nodeGroupId",
            preferred_availability_zones=["preferredAvailabilityZones"]
        )]
    )]
)

Attributes

automatic_failover_enabled

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-automaticfailoverenabled

Return type

Union[bool, IResolvable, None]

cache_node_type

The cache node type of the Global datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cachenodetype

Return type

Optional[str]

cache_parameter_group_name

The name of the cache parameter group to use with the Global datastore.

It must be compatible with the major engine version used by the Global datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cacheparametergroupname

Return type

Optional[str]

engine_version

The Elasticache Redis engine version.

Link

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

Return type

Optional[str]

global_node_group_count

The number of node groups that comprise the Global Datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalnodegroupcount

Return type

Union[int, float, None]

global_replication_group_description

The optional description of the Global datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupdescription

Return type

Optional[str]

global_replication_group_id_suffix

The suffix name of a Global Datastore.

The suffix guarantees uniqueness of the Global Datastore name across multiple regions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupidsuffix

Return type

Optional[str]

members

The replication groups that comprise the Global datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-members

Return type

Union[IResolvable, List[Union[IResolvable, GlobalReplicationGroupMemberProperty]]]

regional_configurations

The Amazon Regions that comprise the Global Datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-regionalconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, RegionalConfigurationProperty]], None]