Skip to content

README.md

Latest commit

 

History

History
85 lines (72 loc) · 7.86 KB

README.md

File metadata and controls

85 lines (72 loc) · 7.86 KB

ElastiCache Redis

Provision a Redis cluster using AWS ElastiCache.

Requirements

Name Version
terraform >= 1.6.2
aws ~> 5.0
random ~> 3.0

Providers

Name Version
aws ~> 5.0
random ~> 3.0

Modules

Name Source Version
client_security_group ../../security-group n/a
customer_kms github.com/thoughtbot/terraform-aws-secrets//customer-managed-kms v0.8.0
server_security_group ../../security-group n/a

Resources

Name Type
aws_cloudwatch_metric_alarm.check_cpu_balance resource
aws_cloudwatch_metric_alarm.cpu resource
aws_cloudwatch_metric_alarm.memory resource
aws_elasticache_replication_group.this resource
aws_elasticache_subnet_group.this resource
random_password.auth_token resource
aws_ec2_instance_type.instance_attributes data source

Inputs

Name Description Type Default Required
alarm_actions SNS topcis or other actions to invoke for alarms list(object({ arn = string })) [] no
allowed_cidr_blocks CIDR blocks allowed to access the database list(string) [] no
allowed_security_group_ids Security group allowed to access the database list(string) [] no
apply_immediately Set to true to apply changes immediately bool false no
at_rest_encryption_enabled Set to false to disable encryption at rest bool true no
client_security_group_name Override the name for the security group; defaults to identifer string "" no
create_client_security_group Set to false to only use existing security groups bool true no
create_server_security_group Set to false to only use existing security groups bool true no
description Human-readable description for this replication group string n/a yes
enable_kms Enable KMS encryption bool true no
engine Elasticache database engine; defaults to Redis string "redis" no
engine_version Version for RDS database engine string n/a yes
global_replication_group_id The ID of the global replication group to which this replication group should belong. string null no
initial_auth_token Override the initial auth token string null no
kms_key_id KMS key to encrypt data at rest string null no
name Name for this cluster string n/a yes
node_type Node type for the Elasticache instance string n/a yes
parameter_group_name Parameter group name for the Redis cluster string null no
port Port on which to listen number 6379 no
replica_count Number of read-only replicas to add to the cluster number 1 no
replication_group_id Override the ID for the replication group string "" no
server_security_group_ids IDs of VPC security groups for this instance. One of vpc_id or server_security_group_ids is required list(string) [] no
server_security_group_name Override the name for the security group; defaults to identifer string "" no
snapshot_name Name of an existing snapshot from which to create a cluster string null no
snapshot_retention_limit Number of days to retain snapshots number 7 no
subnet_group_name Override the name for the subnet group string "" no
subnet_ids Subnets connected to the database list(string) n/a yes
tags Tags to be applied to created resources map(string) {} no
transit_encryption_enabled Set to false to disable TLS bool true no
vpc_id ID of VPC for this instance. One of vpc_id or vpc_security_group_ids is required string null no

Outputs

Name Description
client_security_group_id Name of the security group created for clients
id ID of the created replication group
initial_auth_token Initial value for the user auth token
instance Elasticache Redis replication group
server_security_group_id Name of the security group created for the server