CfnReplicationGroupProps

class aws_cdk.aws_elasticache.CfnReplicationGroupProps(*, replication_group_description, at_rest_encryption_enabled=None, auth_token=None, automatic_failover_enabled=None, auto_minor_version_upgrade=None, cache_node_type=None, cache_parameter_group_name=None, cache_security_group_names=None, cache_subnet_group_name=None, data_tiering_enabled=None, engine=None, engine_version=None, global_replication_group_id=None, kms_key_id=None, log_delivery_configurations=None, multi_az_enabled=None, node_group_configuration=None, notification_topic_arn=None, num_cache_clusters=None, num_node_groups=None, port=None, preferred_cache_cluster_a_zs=None, preferred_maintenance_window=None, primary_cluster_id=None, replicas_per_node_group=None, replication_group_id=None, security_group_ids=None, snapshot_arns=None, snapshot_name=None, snapshot_retention_limit=None, snapshotting_cluster_id=None, snapshot_window=None, tags=None, transit_encryption_enabled=None, user_group_ids=None)

Bases: object

Properties for defining a CfnReplicationGroup.

Parameters
  • replication_group_description (str) – A user-created description for the replication group.

  • at_rest_encryption_enabled (Union[bool, IResolvable, None]) – A flag that enables encryption at rest when set to true . You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x onward. Default: false

  • auth_token (Optional[str]) – Reserved parameter. The password used to access a password protected server. AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true . For more information, see Authenticating Users with the Redis AUTH Command . .. epigraph:: For HIPAA compliance, you must specify TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup . Password constraints: - Must be only printable ASCII characters. - Must be at least 16 characters and no more than 128 characters in length. - Nonalphanumeric characters are restricted to (!, &, #, $, ^, <, >, -, ). For more information, see AUTH password at http://redis.io/commands/AUTH.

  • 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. Default: false

  • auto_minor_version_upgrade (Union[bool, IResolvable, None]) – If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

  • cache_node_type (Optional[str]) – The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. - General purpose: - Current generation: M6g node types: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.12xlarge , cache.m6g.24xlarge M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge T4g node types: cache.t4g.micro , cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium - Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge - Compute optimized: - Previous generation: (not recommended) C1 node types: cache.c1.xlarge - Memory optimized: - Current generation: R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge .. epigraph:: The r6gd family is available in the following regions: us-east-2 , us-east-1 , us-west-2 , us-west-1 , eu-west-1 , eu-central-1 , ap-northeast-1 , ap-southeast-1 , ap-southeast-2 . R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.12xlarge , cache.r6g.24xlarge R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , cache.r4.8xlarge , cache.r4.16xlarge - Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge For region availability, see Supported Node Types by Amazon Region

  • cache_parameter_group_name (Optional[str]) – The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. - To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2 . - To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on .

  • cache_security_group_names (Optional[Sequence[str]]) – A list of cache security group names to associate with this replication group.

  • cache_subnet_group_name (Optional[str]) – The name of the cache subnet group to be used for the replication group. .. epigraph:: If you’re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see AWS::ElastiCache::SubnetGroup .

  • data_tiering_enabled (Union[bool, IResolvable, None]) – Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering .

  • engine (Optional[str]) – The name of the cache engine to be used for the clusters in this replication group. Must be Redis.

  • engine_version (Optional[str]) – The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ) in the ElastiCache User Guide , but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

  • global_replication_group_id (Optional[str]) – The name of the Global datastore.

  • kms_key_id (Optional[str]) – The ID of the KMS key used to encrypt the disk on the cluster.

  • log_delivery_configurations (Union[IResolvable, Sequence[Union[IResolvable, LogDeliveryConfigurationRequestProperty, Dict[str, Any]]], None]) – Specifies the destination, format and type of the logs.

  • multi_az_enabled (Union[bool, IResolvable, None]) – A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ .

  • node_group_configuration (Union[IResolvable, Sequence[Union[IResolvable, NodeGroupConfigurationProperty, Dict[str, Any]]], None]) – NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. If you set UseOnlineResharding to true , you can update NodeGroupConfiguration without interruption. When UseOnlineResharding is set to false , or is not specified, updating NodeGroupConfiguration results in replacement .

  • notification_topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. .. epigraph:: The Amazon SNS topic owner must be the same as the cluster owner.

  • num_cache_clusters (Union[int, float, None]) – The number of clusters this replication group initially has. This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true , the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6. The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

  • num_node_groups (Union[int, float, None]) –

    An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. If you set UseOnlineResharding to true , you can update NumNodeGroups without interruption. When UseOnlineResharding is set to false , or is not specified, updating NumNodeGroups results in replacement . Default: 1

  • port (Union[int, float, None]) – The port number on which each member of the replication group accepts connections.

  • preferred_cache_cluster_a_zs (Optional[Sequence[str]]) – A list of EC2 Availability Zones in which the replication group’s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. .. epigraph:: If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheClusters . Default: system chosen Availability Zones.

  • preferred_maintenance_window (Optional[str]) – Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: - sun - mon - tue - wed - thu - fri - sat Example: sun:23:00-mon:01:30

  • primary_cluster_id (Optional[str]) – The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available . This parameter is not required if NumCacheClusters , NumNodeGroups , or ReplicasPerNodeGroup is specified.

  • replicas_per_node_group (Union[int, float, None]) – An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

  • replication_group_id (Optional[str]) – The replication group identifier. This parameter is stored as a lowercase string. Constraints: - A name must contain from 1 to 40 alphanumeric characters or hyphens. - The first character must be a letter. - A name cannot end with a hyphen or contain two consecutive hyphens.

  • security_group_ids (Optional[Sequence[str]]) – One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

  • snapshot_arns (Optional[Sequence[str]]) – A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

  • snapshot_name (Optional[str]) – The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

  • snapshot_retention_limit (Union[int, float, None]) – The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. Default: 0 (i.e., automatic backups are disabled for this cluster).

  • snapshotting_cluster_id (Optional[str]) – The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

  • snapshot_window (Optional[str]) – The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key= myKey , Value= myKeyValue . You can include multiple tags as shown following: Key= myKey , Value= myKeyValue Key= mySecondKey , Value= mySecondKeyValue . Tags on replication groups will be replicated to all nodes.

  • transit_encryption_enabled (Union[bool, IResolvable, None]) – A flag that enables in-transit encryption when set to true . You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. This parameter is valid only if the Engine parameter is redis , the EngineVersion parameter is 3.2.6 or 4.x onward, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup . Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x onward. Default: false .. epigraph:: For HIPAA compliance, you must specify TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup .

  • user_group_ids (Optional[Sequence[str]]) – The list of user groups to associate with the replication group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.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_replication_group_props = elasticache.CfnReplicationGroupProps(
    replication_group_description="replicationGroupDescription",

    # the properties below are optional
    at_rest_encryption_enabled=False,
    auth_token="authToken",
    automatic_failover_enabled=False,
    auto_minor_version_upgrade=False,
    cache_node_type="cacheNodeType",
    cache_parameter_group_name="cacheParameterGroupName",
    cache_security_group_names=["cacheSecurityGroupNames"],
    cache_subnet_group_name="cacheSubnetGroupName",
    data_tiering_enabled=False,
    engine="engine",
    engine_version="engineVersion",
    global_replication_group_id="globalReplicationGroupId",
    kms_key_id="kmsKeyId",
    log_delivery_configurations=[elasticache.CfnReplicationGroup.LogDeliveryConfigurationRequestProperty(
        destination_details=elasticache.CfnReplicationGroup.DestinationDetailsProperty(
            cloud_watch_logs_details=elasticache.CfnReplicationGroup.CloudWatchLogsDestinationDetailsProperty(
                log_group="logGroup"
            ),
            kinesis_firehose_details=elasticache.CfnReplicationGroup.KinesisFirehoseDestinationDetailsProperty(
                delivery_stream="deliveryStream"
            )
        ),
        destination_type="destinationType",
        log_format="logFormat",
        log_type="logType"
    )],
    multi_az_enabled=False,
    node_group_configuration=[elasticache.CfnReplicationGroup.NodeGroupConfigurationProperty(
        node_group_id="nodeGroupId",
        primary_availability_zone="primaryAvailabilityZone",
        replica_availability_zones=["replicaAvailabilityZones"],
        replica_count=123,
        slots="slots"
    )],
    notification_topic_arn="notificationTopicArn",
    num_cache_clusters=123,
    num_node_groups=123,
    port=123,
    preferred_cache_cluster_aZs=["preferredCacheClusterAZs"],
    preferred_maintenance_window="preferredMaintenanceWindow",
    primary_cluster_id="primaryClusterId",
    replicas_per_node_group=123,
    replication_group_id="replicationGroupId",
    security_group_ids=["securityGroupIds"],
    snapshot_arns=["snapshotArns"],
    snapshot_name="snapshotName",
    snapshot_retention_limit=123,
    snapshotting_cluster_id="snapshottingClusterId",
    snapshot_window="snapshotWindow",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    transit_encryption_enabled=False,
    user_group_ids=["userGroupIds"]
)

Attributes

at_rest_encryption_enabled

A flag that enables encryption at rest when set to true .

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x onward.

Default: false

Link

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

Return type

Union[bool, IResolvable, None]

auth_token

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true . For more information, see Authenticating Users with the Redis AUTH Command . .. epigraph:

For HIPAA compliance, you must specify ``TransitEncryptionEnabled`` as ``true`` , an ``AuthToken`` , and a ``CacheSubnetGroup`` .

Password constraints:

  • Must be only printable ASCII characters.

  • Must be at least 16 characters and no more than 128 characters in length.

  • Nonalphanumeric characters are restricted to (!, &, #, $, ^, <, >, -, ).

For more information, see AUTH password at http://redis.io/commands/AUTH.

Link

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

Return type

Optional[str]

auto_minor_version_upgrade

If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

Link

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

Return type

Union[bool, IResolvable, None]

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.

Default: false

Link

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

Return type

Union[bool, IResolvable, None]

cache_node_type

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

  • Current generation:

M6g node types: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.12xlarge , cache.m6g.24xlarge

M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge

M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge

T4g node types: cache.t4g.micro , cache.t4g.small , cache.t4g.medium

T3 node types: cache.t3.micro , cache.t3.small , cache.t3.medium

T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium

  • Previous generation: (not recommended)

T1 node types: cache.t1.micro

M1 node types: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge

M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge

  • Compute optimized:

  • Previous generation: (not recommended)

C1 node types: cache.c1.xlarge

  • Memory optimized:

  • Current generation:

R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge .. epigraph:

The ``r6gd`` family is available in the following regions: ``us-east-2`` , ``us-east-1`` , ``us-west-2`` , ``us-west-1`` , ``eu-west-1`` , ``eu-central-1`` , ``ap-northeast-1`` , ``ap-southeast-1`` , ``ap-southeast-2`` .

R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.12xlarge , cache.r6g.24xlarge

R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge

R4 node types: cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , cache.r4.8xlarge , cache.r4.16xlarge

  • Previous generation: (not recommended)

M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge

R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge

For region availability, see Supported Node Types by Amazon Region

Link

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

Return type

Optional[str]

cache_parameter_group_name

The name of the parameter group to associate with this replication group.

If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2 .

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on .

Link

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

Return type

Optional[str]

cache_security_group_names

A list of cache security group names to associate with this replication group.

Link

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

Return type

Optional[List[str]]

cache_subnet_group_name

The name of the cache subnet group to be used for the replication group.

If you’re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see AWS::ElastiCache::SubnetGroup .

Link

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

Return type

Optional[str]

data_tiering_enabled

Enables data tiering.

Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering .

Link

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

Return type

Union[bool, IResolvable, None]

engine

The name of the cache engine to be used for the clusters in this replication group.

Must be Redis.

Link

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

Return type

Optional[str]

engine_version

The version number of the cache engine to be used for the clusters in this replication group.

To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ) in the ElastiCache User Guide , but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Link

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

Return type

Optional[str]

global_replication_group_id

The name of the Global datastore.

Link

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

Return type

Optional[str]

kms_key_id

The ID of the KMS key used to encrypt the disk on the cluster.

Link

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

Return type

Optional[str]

log_delivery_configurations

Specifies the destination, format and type of the logs.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, LogDeliveryConfigurationRequestProperty]], None]

multi_az_enabled

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.

For more information, see Minimizing Downtime: Multi-AZ .

Link

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

Return type

Union[bool, IResolvable, None]

node_group_configuration

NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.

If you set UseOnlineResharding to true , you can update NodeGroupConfiguration without interruption. When UseOnlineResharding is set to false , or is not specified, updating NodeGroupConfiguration results in replacement .

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, NodeGroupConfigurationProperty]], None]

notification_topic_arn

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Link

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

Return type

Optional[str]

num_cache_clusters

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true , the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

Link

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

Return type

Union[int, float, None]

num_node_groups

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group.

For Redis (cluster mode disabled) either omit this parameter or set it to 1.

If you set UseOnlineResharding to true , you can update NumNodeGroups without interruption. When UseOnlineResharding is set to false , or is not specified, updating NumNodeGroups results in replacement .

Default: 1

Link

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

Return type

Union[int, float, None]

port

The port number on which each member of the replication group accepts connections.

Link

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

Return type

Union[int, float, None]

preferred_cache_cluster_a_zs

A list of EC2 Availability Zones in which the replication group’s clusters are created.

The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. .. epigraph:

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of ``NumCacheClusters`` .

Default: system chosen Availability Zones.

Link

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

Return type

Optional[List[str]]

preferred_maintenance_window

Specifies the weekly time range during which maintenance on the cluster is performed.

It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

Link

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

Return type

Optional[str]

primary_cluster_id

The identifier of the cluster that serves as the primary for this replication group.

This cluster must already exist and have a status of available .

This parameter is not required if NumCacheClusters , NumNodeGroups , or ReplicasPerNodeGroup is specified.

Link

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

Return type

Optional[str]

replicas_per_node_group

An optional parameter that specifies the number of replica nodes in each node group (shard).

Valid values are 0 to 5.

Link

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

Return type

Union[int, float, None]

replication_group_description

A user-created description for the replication group.

Link

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

Return type

str

replication_group_id

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Link

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

Return type

Optional[str]

security_group_ids

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Link

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

Return type

Optional[List[str]]

snapshot_arns

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.

The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Link

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

Return type

Optional[List[str]]

snapshot_name

The name of a snapshot from which to restore data into the new replication group.

The snapshot status changes to restoring while the new replication group is being created.

Link

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

Return type

Optional[str]

snapshot_retention_limit

The number of days for which ElastiCache retains automatic snapshots before deleting them.

For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Default: 0 (i.e., automatic backups are disabled for this cluster).

Link

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

Return type

Union[int, float, None]

snapshot_window

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Link

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

Return type

Optional[str]

snapshotting_cluster_id

The cluster ID that is used as the daily snapshot source for the replication group.

This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Link

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

Return type

Optional[str]

tags

A list of tags to be added to this resource.

Tags are comma-separated key,value pairs (e.g. Key= myKey , Value= myKeyValue . You can include multiple tags as shown following: Key= myKey , Value= myKeyValue Key= mySecondKey , Value= mySecondKeyValue . Tags on replication groups will be replicated to all nodes.

Link

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

Return type

Optional[List[CfnTag]]

transit_encryption_enabled

A flag that enables in-transit encryption when set to true .

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis , the EngineVersion parameter is 3.2.6 or 4.x onward, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup .

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x onward.

Default: false .. epigraph:

For HIPAA compliance, you must specify ``TransitEncryptionEnabled`` as ``true`` , an ``AuthToken`` , and a ``CacheSubnetGroup`` .
Link

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

Return type

Union[bool, IResolvable, None]

user_group_ids

The list of user groups to associate with the replication group.

Link

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

Return type

Optional[List[str]]