Module: elasticache-memcached

Terraform module to provision an ElastiCache Memcached Cluster

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

  provider "aws" {
    region = var.region
  }

  module "this" {
    source  = "cloudposse/label/null"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    namespace  = var.namespace
    stage      = var.stage
    name       = var.name
  }

  module "vpc" {
    source = "cloudposse/vpc/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    cidr_block = "172.16.0.0/16"

    context = module.this.context
  }

  module "subnets" {
    source = "cloudposse/dynamic-subnets/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    availability_zones   = var.availability_zones
    vpc_id               = module.vpc.vpc_id
    igw_id               = module.vpc.igw_id
    cidr_block           = module.vpc.vpc_cidr_block
    nat_gateway_enabled  = true
    nat_instance_enabled = false

    context = module.this.context
  }

  module "memcached" {
    source = "cloudposse/elasticache-memcached/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    availability_zones      = var.availability_zones
    vpc_id                  = module.vpc.vpc_id
    allowed_security_groups = [module.vpc.vpc_default_security_group_id]
    subnets                 = module.subnets.private_subnet_ids
    cluster_size            = var.cluster_size
    instance_type           = var.instance_type
    engine_version          = var.engine_version
    apply_immediately       = true
    zone_id                 = var.zone_id

    elasticache_parameter_group_family = var.elasticache_parameter_group_family

    context = module.this.context
  }

Examples

Review the complete example to see how to use this module.

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 5.16
null	>= 3.0

Providers

Name	Version
aws	>= 5.16
null	>= 3.0

Modules

Name	Source	Version
aws_security_group	cloudposse/security-group/aws	2.2.0
dns	cloudposse/route53-cluster-hostname/aws	0.13.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudwatch_metric_alarm.cache_cpu	resource
aws_cloudwatch_metric_alarm.cache_memory	resource
aws_elasticache_cluster.default	resource
aws_elasticache_parameter_group.default	resource
aws_elasticache_subnet_group.default	resource
null_resource.cluster_urls	resource

Inputs

Name	Description	Type	Default	Required
additional_security_group_rules	A list of Security Group rule objects to add to the created security group, in addition to the ones this module normally creates. (To suppress the module's rules, set create_security_group to false and supply your own security group via associated_security_group_ids.) The keys and values of the objects are fully compatible with the aws_security_group_rule resource, except for security_group_id which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time. To get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule .	list(any)	[]	no
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
alarm_actions	Alarm actions	list(string)	[]	no
alarm_cpu_threshold_percent	CPU threshold alarm level	number	75	no
alarm_memory_threshold_bytes	Alarm memory threshold bytes	number	10000000	no
allow_all_egress	If true, the created security group will allow egress on all ports and protocols to all IP address. If this is false and no egress rules are otherwise specified, then no egress will be allowed.	bool	true	no
allowed_cidr_blocks	A list of IPv4 CIDRs to allow access to the security group created by this module. The length of this list must be known at "plan" time.	list(string)	[]	no
allowed_ipv6_cidr_blocks	A list of IPv6 CIDRs to allow access to the security group created by this module. The length of this list must be known at "plan" time.	list(string)	[]	no
allowed_ipv6_prefix_list_ids	A list of IPv6 Prefix Lists IDs to allow access to the security group created by this module. The length of this list must be known at "plan" time.	list(string)	[]	no
allowed_security_group_ids	A list of IDs of Security Groups to allow access to the security group created by this module. The length of this list must be known at "plan" time.	list(string)	[]	no
allowed_security_groups	DEPRECATED: Use allowed_security_group_ids instead.	list(string)	[]	no
apply_immediately	Specifies whether any database modifications are applied immediately, or during the next maintenance window	bool	true	no
associated_security_group_ids	A list of IDs of Security Groups to associate the created resource with, in addition to the created security group. These security groups will not be modified and, if create_security_group is false, must have rules providing the desired access.	list(string)	[]	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
availability_zone	The Availability Zone of the cluster. az_mode must be set to single-az when used.	string	""	no
availability_zones	List of Availability Zones for the cluster. az_mode must be set to cross-az when used.	list(string)	[]	no
az_mode	Enable or disable multiple AZs, eg: single-az or cross-az	string	"single-az"	no
cloudwatch_metric_alarms_enabled	Boolean flag to enable/disable CloudWatch metrics alarms	bool	false	no
cluster_size	Cluster size	number	1	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
create_security_group	Set true to create and configure a new security group. If false, associated_security_group_ids must be provided.	bool	true	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
dns_subdomain	The subdomain to use for the CNAME record. If not provided then the CNAME record will use var.name.	string	""	no
elasticache_parameter_group_family	ElastiCache parameter group family	string	"memcached1.5"	no
elasticache_subnet_group_name	Subnet group name for the ElastiCache instance	string	""	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
engine_version	Memcached engine version. For more info, see https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/supported-engine-versions.html	string	"1.5.16"	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
existing_security_groups	DEPRECATED: Use associated_security_group_ids instead. Historical description: List of existing Security Group IDs to place the cluster into. Set use_existing_security_groups to true to enable using existing_security_groups as Security Groups for the cluster.	list(string)	[]	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
instance_type	Elastic cache instance type	string	"cache.t2.micro"	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
maintenance_window	Maintenance window	string	"wed:03:00-wed:04:00"	no
max_item_size	Max item size	number	10485760	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
notification_topic_arn	Notification topic arn	string	""	no
port	Memcached port	number	11211	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
security_group_create_before_destroy	Set true to enable Terraform create_before_destroy behavior on the created security group. We only recommend setting this false if you are upgrading this module and need to keep the existing security group from being replaced. Note that changing this value will always cause the security group to be replaced.	bool	true	no
security_group_create_timeout	How long to wait for the security group to be created.	string	"10m"	no
security_group_delete_timeout	How long to retry on DependencyViolation errors during security group deletion.	string	"15m"	no
security_group_description	The description to assign to the created Security Group. Warning: Changing the description causes the security group to be replaced.	string	"Security group for Elasticache Memcached"	no
security_group_name	The name to assign to the created security group. Must be unique within the VPC. If not provided, will be derived from the null-label.context passed in. If create_before_destroy is true, will be used as a name prefix.	list(string)	[]	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subnets	AWS subnet ids	list(string)	[]	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
transit_encryption_enabled	Boolean flag to enable transit encryption (requires Memcached version 1.6.12+)	bool	false	no
use_existing_security_groups	DEPRECATED: Use create_security_group instead. Historical description: Flag to enable/disable creation of Security Group in the module. Set to true to disable Security Group creation and provide a list of existing security Group IDs in existing_security_groups to place the cluster into. Historical default: false	bool	null	no
vpc_id	VPC ID	string	""	no
zone_id	Route53 DNS Zone ID	string	""	no

Outputs

Name	Description
cluster_address	Cluster address
cluster_configuration_endpoint	Cluster configuration endpoint
cluster_id	Cluster ID
cluster_urls	Cluster URLs
hostname	Cluster hostname
security_group_arn	The ARN of the created security group
security_group_id	The ID of the created security group
security_group_name	The name of the created security group