Amazon ElastiCache for Redis

Deploy and manage Amazon ElastiCache for Redis

View on GitHub

Reference

Inputs

• alarms_sns_topic_arns — The ARNs of SNS topics where CloudWatch alarms (e.g., for CPU, memory, and disk space usage) should send notifications.

• allow_connections_from_cidr_blocks — The list of network CIDR blocks to allow network access to ElastiCache from. One of allow_connections_from_cidr_blocks or allow_connections_from_security_groups must be specified for the ElastiCache instances to be reachable.

• allow_connections_from_security_groups — The list of IDs or Security Groups to allow network access to ElastiCache from. All security groups must either be in the VPC specified by vpc_id, or a peered VPC with the VPC specified by vpc_id. One of allow_connections_from_cidr_blocks or allow_connections_from_security_groups must be specified for the ElastiCache instances to be reachable.

• apply_immediately — Specifies whether any modifications are applied immediately, or during the next maintenance window.

• cluster_mode — Specifies the number of shards and replicas per shard in the cluster. The list should contain a single map with keys 'num_node_groups' and 'replicas_per_node_group' set to desired integer values.

• enable_at_rest_encryption — Whether to enable encryption at rest.

• enable_automatic_failover — 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 replication_group_size.

• enable_cloudwatch_alarms — Set to true to enable several basic CloudWatch alarms around CPU usage, memory usage, and disk space usage. If set to true, make sure to specify SNS topics to send notifications to using alarms_sns_topic_arn.

• enable_multi_az — 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 replication_group_size.

• enable_transit_encryption — Whether to enable encryption in transit.

• instance_type — The compute and memory capacity of the nodes (e.g. cache.m4.large).

• maintenance_window — Specifies the weekly time range for when maintenance on the cache cluster is performed (e.g. sun:05:00-sun:09:00). The format is ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

• name — The name used to namespace all resources created by these templates, including the ElastiCache cluster itself (e.g. rediscache). Must be unique in this region. Must be a lowercase string.

• parameter_group_name — Name of the parameter group to associate with this cache cluster. This can be used to configure custom settings for the cluster.

• port — The port number on which each of the cache nodes will accept connections (e.g. 6379).

• redis_version — Version number of redis to use (e.g. 5.0.6).

• replication_group_size — The total number of nodes in the Redis Replication Group. E.g. 1 represents just the primary node, 2 represents the primary plus a single Read Replica.

• snapshot_retention_limit — The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. Set to 0 to disable snapshots.

• snapshot_window — The daily time range during which automated backups are created (e.g. 04:00-09:00). Time zone is UTC. Performance may be degraded while a backup runs. Set to empty string to disable snapshots.

• sns_topic_for_notifications — The ARN of the SNS Topic to which notifications will be sent when a Replication Group event happens, such as an automatic failover (e.g. arn:aws:sns:*:123456789012:my_sns_topic). An empty string is a valid value if you do not wish to receive notifications via SNS.

• subnet_ids — The list of IDs of the subnets in which to deploy the ElasticCache instances. The list must only contain subnets in vpc_id.

• tags — A set of tags to set for the ElastiCache Replication Group.

• vpc_id — The ID of the VPC in which to deploy RDS.

Outputs

• cache_cluster_ids — The list of AWS cache cluster ids where each one represents a Redis node.

• cache_node_id — The id of the ElastiCache node. Note: Each Redis cache cluster has only one node and its id is always 0001.

• cache_port — The port number on which each of the cache nodes will accept connections (e.g. 6379).

• configuration_endpoint — When cluster mode is enabled, use this endpoint for all operations. Redis will automatically determine which of the cluster's node to access.

• primary_endpoint — The primary endpoint is a DNS name that always resolves to the primary node in the Redis cluster.

• reader_endpoint — When cluster mode is disabled, use this endpoint for all read operations.