--- type: resource-type title: ReplicationGroup description: aws resource type AWS::ElastiCache::ReplicationGroup name: ReplicationGroup lexicon: aws resource_type: AWS::ElastiCache::ReplicationGroup --- `AWS::ElastiCache::ReplicationGroup`, a resource type of the aws lexicon. ## Properties - `ReplicationGroupDescription` (`string`, required): A user-created description for the replication group. - `AtRestEncryptionEnabled` (`boolean`, optional): A flag that enables encryption at rest when set to true.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. - `AuthToken` (`string`, optional): 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. - `AutomaticFailoverEnabled` (`boolean`, optional): 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. - `AutoMinorVersionUpgrade` (`boolean`, optional): This parameter is currently disabled. - `CacheNodeType` (`string`, optional): The compute and memory capacity of the nodes in the node group (shard). - `CacheParameterGroupName` (`string`, optional): 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. - `CacheSecurityGroupNames` (`string[]`, optional): A list of cache security group names to associate with this replication group. - `CacheSubnetGroupName` (`string`, optional): The name of the cache subnet group to be used for the replication group. - `ClusterMode` (`string`, optional): Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode. - `ConfigurationEndPoint` (`ReplicationGroup_Endpoint`, optional): The configuration details of the replication group. - `DataTieringEnabled` (`boolean`, optional): 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. - `Durability` (`"async" | "default" | "disabled" | "sync"`, optional): The durability setting for the replication group. Valid values: default, async, sync, disabled. Enabling durability on an existing non-durable cluster or disabling durability on an existing durable cluster is not currently supported and will result in an error; specify the desired durability at create time. The resolved state is returned in EffectiveDurability. - `EffectiveDurability` (`"async" | "disabled" | "sync"`, optional): The resolved durability state of the replication group after resolving the default value. This is a read-only property. - `Engine` (`string`, optional): The name of the cache engine to be used for the clusters in this replication group. - `EngineVersion` (`string`, optional): 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. - `GlobalReplicationGroupId` (`string`, optional): The name of the Global datastore - `IpDiscovery` (`string`, optional): The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system. - `KmsKeyId` (`string`, optional): The ID of the KMS key used to encrypt the disk on the cluster. - `LogDeliveryConfigurations` (`ReplicationGroup_LogDeliveryConfigurationRequest[]`, optional): Specifies the destination, format and type of the logs. - `MultiAZEnabled` (`boolean`, optional): A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ. - `NetworkType` (`string`, optional): Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system - `NodeGroupConfiguration` (`ReplicationGroup_NodeGroupConfiguration[]`, optional): NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. - `NotificationTopicArn` (`string`, optional): The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. - `NumCacheClusters` (`number`, optional): 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. - `NumNodeGroups` (`number`, optional): 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. - `Port` (`number`, optional): The port number on which each member of the replication group accepts connections. - `PreferredCacheClusterAZs` (`string[]`, optional): 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. - `PreferredMaintenanceWindow` (`string`, optional): 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. - `PrimaryClusterId` (`string`, optional): 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. - `PrimaryEndPoint` (`ReplicationGroup_Endpoint`, optional): The primary endpoint configuration - `ReadEndPoint` (`Record`, optional) - `ReaderEndPoint` (`ReplicationGroup_Endpoint`, optional): The endpoint of the reader node in the replication group. - `ReplicasPerNodeGroup` (`number`, optional): An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5. *Note:** Using ReplicasPerNodeGroup with NodeGroupConfiguration results in resource replacement. For online scaling, use ReplicasPerNodeGroup alone. - `ReplicationGroupId` (`string`, optional): The replication group identifier. This parameter is stored as a lowercase string. - `SecurityGroupIds` (`string[]`, optional): One or more Amazon VPC security groups associated with this replication group. - `SnapshotArns` (`string[]`, optional): A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. - `SnapshotName` (`string`, optional): 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. - `SnapshotRetentionLimit` (`number`, optional): 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. - `SnapshottingClusterId` (`string`, optional): 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. - `SnapshotWindow` (`string`, optional): The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). - `Tags` (`ReplicationGroup_Tag[]`, optional): A list of cost allocation 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. - `TransitEncryptionEnabled` (`boolean`, optional): A flag that enables in-transit encryption when set to true. - `TransitEncryptionMode` (`string`, optional): A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis OSS clients to use encrypted connections you can modify the value to required to allow encrypted connections only. Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required. This process will not trigger the replacement of the replication group. - `UserGroupIds` (`string[]`, optional): The ID of user group to associate with the replication group. ## Attributes - `ConfigurationEndPoint` - `ConfigurationEndPoint.Address` - `ConfigurationEndPoint.Port` - `EffectiveDurability` - `PrimaryEndPoint` - `PrimaryEndPoint.Address` - `PrimaryEndPoint.Port` - `ReadEndPoint` - `ReadEndPoint.Addresses` - `ReadEndPoint.AddressesList` - `ReadEndPoint.Ports` - `ReadEndPoint.PortsList` - `ReaderEndPoint` - `ReaderEndPoint.Address` - `ReaderEndPoint.Port`