yunsang-jeong/terraform-aws-cache-redis

AWS ElastiCache for redis를 Cluster 모드로 생성하는 모듈입니다.

Overview

AWS ElastiCache for redis를 Cluster 모드로 생성하는 모듈입니다. 하단의 내용은 terraform-docs에 의해 생성되었습니다.

Providers

Name	Version
aws	3.50.0

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 3.35.0

Inputs

Name	Description	Type	Default	Required
apply_immediately	(opt) Whether any database modifications are applied immediately, or during the next maintenance window.	bool	false	no
at_rest_encryption_enabled	Whether to enable encryption at rest.	bool	null	no
auth_token	The password used to access a password protected server.	string	null	no
auto_minor_version_upgrade	(optional)	bool	null	no
automatic_failover_enabled	Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.	bool	false	no
availability_zones	(optional)	set(string)	null	no
cluster_mode	Create a native Redis cluster. automatic_failover_enabled must be set to true.	object( { num_node_groups = number replicas_per_node_group = number } )	null	no
engine_version	(opt) Version number of the cache engine to be used.	string	null	no
final_snapshot_identifier	The name of your final node group (shard) snapshot.	string	null	no
global_additional_tag	Additional tags for all resources.	map(string)	{}	no
global_replication_group_id	(opt)	string	null	no
kms_key_id	The ARN of the key that you wish to use if encrypting at rest.	string	null	no
maintenance_window	(opt) Specifies the weekly time range for when maintenance on the cache cluster is performed	string	null	no
multi_az_enabled	(optional)	bool	null	no
name_tag_convention	The name tag convention of all resources.	object({ project_name = string stage = string })	{ "project_name": "tf", "stage": "poc" }	no
node_type	(opt) The instance class used	string	null	no
notification_topic_arn	An ARN of an SNS topic to send ElastiCache notifications to.	string	null	no
number_cache_clusters	The number of cache clusters (primary and replicas) this replication group will have.	number	null	no
parameter_group_description	The description of the ElastiCache parameter group.	string	""	no
parameter_group_family	The family of the ElastiCache parameter group.	string	n/a	yes
parameter_group_values	A list of ElastiCache parameter to apply	set(object({ name = string value = string }))	[]	no
port	(opt) The port number of on which each of the cache nodes will accept connections.	number	6379	no
replication_group_description	(req)	string	""	no
replication_group_id	(req)	string	n/a	yes
security_group_ids	One or more VPC security groups associated with the cache cluster.	set(string)	null	no
snapshot_arns	A list of Amazon Resource Names (ARNs) that identify Redis RDB snapshot files stored in Amazon S3.	set(string)	null	no
snapshot_name	The name of a snapshot from which to restore data into the new node group.	string	null	no
snapshot_retention_limit	The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.	number	null	no
snapshot_window	The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. (e.g. 05:00-09:00)	string	null	no
subnet_group_description	The description of the ElastiCache subnet group.	string	""	no
subnet_ids	The list of subnet id for cache node.	set(string)	n/a	yes
tags	A map of tags to assign to the resource.	map(string)	{}	no
timeouts	How long to wait for a replication group to be.	object( { create = string delete = string update = string } )	null	no
transit_encryption_enabled	Whether to enable encryption in transit.	bool	null	no

Outputs

Name	Description
id	The id of replication group.

Example

  apply_immediately = true

  ########################################
  # AWS ElastiCache for redis
  replication_group_id = "my-redis"
  replication_group_description = "Session clustering for web service"

  engine_version = "6.x"
  port = 6379

  node_type = "cache.t3.small"
  multi_az_enabled = true
  # availability_zones = []

  automatic_failover_enabled = true
  cluster_mode = {
    num_node_groups = 1
    replicas_per_node_group = 2
  }
  security_group_ids = [ ]
  ########################################

  ########################################
  # Parameter group
  parameter_group_family = "redis6.x"
  parameter_group_description = "Session clustering for web service"
  parameter_group_values = []
  ########################################

  ########################################
  # Subnet group
  subnet_group_description = "Session clustering for web service"
  subnet_ids = [ ]
  ########################################