Class: ReplicationGroup

ElastiCache.ReplicationGroup

new ReplicationGroup()

Properties:
Name Type Description
AutomaticFailoverEnabled Boolean Required: No. Indicates whether Multi-AZ is enabled. When Multi-AZ is enabled, a read-only replica is automatically promoted to a read-write primary cluster if the existing primary cluster fails. If you specify true, you must specify a value greater than 1 for the NumCacheNodes property. By default, AWS CloudFormation sets the value to true.For more information about Multi-AZ, see Multi-AZ with Redis Replication Groups in the Amazon ElastiCache User Guide.NoteYou cannot enable automatic failover for Redis versions earlier than 2.8.6 or for T1 and T2 cache node types.Update requires: No interruption
AutoMinorVersionUpgrade Boolean Required: No. Currently, this property isn't used by ElastiCache.Update requires: No interruption
CacheNodeType String Required: Yes. The compute and memory capacity of nodes in the node group. To see valid values, see CreateReplicationGroup in the Amazon ElastiCache API Reference Guide.Update requires: Replacement
CacheParameterGroupName String Required: No. The name of the parameter group to associate with this replication group.Update requires: No interruption
CacheSecurityGroupNames String Required: No. A list of cache security group names to associate with this replication group. If you specify the SecurityGroupIds property, do not specify this property; you can specify only one.Update requires: No interruption
CacheSubnetGroupName String Required: No. The name of a cache subnet group to use for this replication group.Update requires: Replacement
Engine String Required: Yes. The name of the cache engine to use for the cache clusters in this replication group. Currently, you can specify only redis.Update requires: Replacement
EngineVersion String Required: No. The version number of the cache engine to use for the cache clusters in this replication group.Update requires: No interruption
NotificationTopicArn String Required: No. The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic to which notifications are sent.Update requires: No interruption
NumCacheClusters Number Required: Yes. The number of cache clusters for this replication group. If automatic failover is enabled, you must specify a value greater than 1.Update requires: Replacement
Port Number Required: No. The port number on which each member of the replication group accepts connections.Update requires: Replacement
PreferredCacheClusterAZs String Required: No. A list of Availability Zones (AZs) in which the cache clusters in this replication group are created.Update requires: Replacement
PreferredMaintenanceWindow String Required: No. The weekly time range during which system maintenance can occur. Use the following format to specify a time range: ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). For example, you can specify sun:22:00-sun:23:30 for Sunday from 10 PM to 11:30 PM.Update requires: No interruption
ReplicationGroupDescription String Required: Yes. The description of the replication group.Update requires: No interruption
SecurityGroupIds String Required: No. A list of Amazon Virtual Private Cloud (Amazon VPC) security groups to associate with this replication group. Use this property only when you are creating a replication group in a VPC. If you specify the CacheSecurityGroupNames property, do not specify this property; you can specify only one.Update requires: No interruption
SnapshotArns String Required: No. A single-element string list that specifies an ARN of a Redis .rdb snapshot file that is stored in Amazon Simple Storage Service (Amazon S3). The snapshot file populates the node group. The Amazon S3 object name in the ARN cannot contain commas. For example, you can specify arn:aws:s3:::my_bucket/snapshot1.rdb.Update requires: Replacement
SnapshotRetentionLimit Number Required: No. The number of days that ElastiCache retains automatic snapshots before deleting them.Update requires: No interruption
SnapshotWindow String Required: No. The time range (in UTC) when ElastiCache takes a daily snapshot of your node group. For example, you can specify 05:00-09:00.Update requires: No interruption
Source:

Extends

  • WKResource

ElastiCache.ReplicationGroup

new ReplicationGroup()

Properties:
Name Type Description
AutomaticFailoverEnabled Boolean Required: No. Indicates whether Multi-AZ is enabled. When Multi-AZ is enabled, a read-only replica is automatically promoted to a read-write primary cluster if the existing primary cluster fails. If you specify true, you must specify a value greater than 1 for the NumCacheNodes property. By default, AWS CloudFormation sets the value to true.For more information about Multi-AZ, see Multi-AZ with Redis Replication Groups in the Amazon ElastiCache User Guide.NoteYou cannot enable automatic failover for Redis versions earlier than 2.8.6 or for T1 and T2 cache node types.Update requires: No interruption
AutoMinorVersionUpgrade Boolean Required: No. Currently, this property isn't used by ElastiCache.Update requires: No interruption
CacheNodeType String Required: Yes. The compute and memory capacity of nodes in the node group. To see valid values, see CreateReplicationGroup in the Amazon ElastiCache API Reference Guide.Update requires: Replacement
CacheParameterGroupName String Required: No. The name of the parameter group to associate with this replication group.Update requires: No interruption
CacheSecurityGroupNames String Required: No. A list of cache security group names to associate with this replication group. If you specify the SecurityGroupIds property, do not specify this property; you can specify only one.Update requires: No interruption
CacheSubnetGroupName String Required: No. The name of a cache subnet group to use for this replication group.Update requires: Replacement
Engine String Required: Yes. The name of the cache engine to use for the cache clusters in this replication group. Currently, you can specify only redis.Update requires: Replacement
EngineVersion String Required: No. The version number of the cache engine to use for the cache clusters in this replication group.Update requires: No interruption
NotificationTopicArn String Required: No. The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic to which notifications are sent.Update requires: No interruption
NumCacheClusters Number Required: Yes. The number of cache clusters for this replication group. If automatic failover is enabled, you must specify a value greater than 1.Update requires: Replacement
Port Number Required: No. The port number on which each member of the replication group accepts connections.Update requires: Replacement
PreferredCacheClusterAZs String Required: No. A list of Availability Zones (AZs) in which the cache clusters in this replication group are created.Update requires: Replacement
PreferredMaintenanceWindow String Required: No. The weekly time range during which system maintenance can occur. Use the following format to specify a time range: ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). For example, you can specify sun:22:00-sun:23:30 for Sunday from 10 PM to 11:30 PM.Update requires: No interruption
ReplicationGroupDescription String Required: Yes. The description of the replication group.Update requires: No interruption
SecurityGroupIds String Required: No. A list of Amazon Virtual Private Cloud (Amazon VPC) security groups to associate with this replication group. Use this property only when you are creating a replication group in a VPC. If you specify the CacheSecurityGroupNames property, do not specify this property; you can specify only one.Update requires: No interruption
SnapshotArns String Required: No. A single-element string list that specifies an ARN of a Redis .rdb snapshot file that is stored in Amazon Simple Storage Service (Amazon S3). The snapshot file populates the node group. The Amazon S3 object name in the ARN cannot contain commas. For example, you can specify arn:aws:s3:::my_bucket/snapshot1.rdb.Update requires: Replacement
SnapshotRetentionLimit Number Required: No. The number of days that ElastiCache retains automatic snapshots before deleting them.Update requires: No interruption
SnapshotWindow String Required: No. The time range (in UTC) when ElastiCache takes a daily snapshot of your node group. For example, you can specify 05:00-09:00.Update requires: No interruption
Source:

Extends

  • WKResource