Skip to main content

Component: elasticache-redis

This component is responsible for provisioning ElastiCache Redis clusters.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

stacks/catalog/elasticache/elasticache-redis/defaults.yaml file (default settings for all Redis clusters):

components:
terraform:
elasticache-redis:
vars:
enabled: true
name: "elasticache-redis"
family: redis6.x
ingress_cidr_blocks: [ ]
egress_cidr_blocks: [ "0.0.0.0/0" ]
port: 6379
at_rest_encryption_enabled: true
transit_encryption_enabled: false
apply_immediately: false
automatic_failover_enabled: false
cloudwatch_metric_alarms_enabled: false
redis_clusters:
redis-main:
num_replicas: 1
num_shards: 0
replicas_per_shard: 0
engine_version: 6.0.5
instance_type: cache.t2.small
parameters:
- name: notify-keyspace-events
value: "lK"

stacks/org/ou/account/region.yaml file (imports and overrides the default settings for a specific cluster):

import:
- catalog/elasticache/elasticache-redis/defaults.yaml

components:
terraform:
elasticache-redis:
vars:
enabled: true
redis_clusters:
redis-main:
num_replicas: 1
num_shards: 0
replicas_per_shard: 0
engine_version: 6.0.5
instance_type: cache.t2.small
parameters:
- name: notify-keyspace-events
value: lK

Requirements

NameVersion
terraform>= 1.0.0
aws>= 4.0

Providers

No providers.

Modules

NameSourceVersion
dns_delegatedcloudposse/stack-config/yaml//modules/remote-state1.5.0
ekscloudposse/stack-config/yaml//modules/remote-state1.5.0
iam_roles../account-map/modules/iam-rolesn/a
redis_clusters./modules/redis_clustern/a
thiscloudposse/label/null0.25.0
vpccloudposse/stack-config/yaml//modules/remote-state1.5.0
vpc_ingresscloudposse/stack-config/yaml//modules/remote-state1.5.0

Resources

No resources.

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional 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
allow_all_egressIf 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.
booltrueno
allow_ingress_from_vpc_stagesList of stages to pull VPC ingress cidr and add to security grouplist(string)[]no
apply_immediatelyApply changes immediatelybooln/ayes
at_rest_encryption_enabledEnable encryption at restbooln/ayes
attributesID 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
auth_token_enabledEnable auth tokenbooltrueno
automatic_failover_enabledEnable automatic failoverbooln/ayes
availability_zonesAvailability zone IDslist(string)[]no
cloudwatch_metric_alarms_enabledBoolean flag to enable/disable CloudWatch metrics alarmsbooln/ayes
contextSingle 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
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe 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
eks_component_namesThe names of the eks componentsset(string)[]no
eks_security_group_enabledUse the eks default security groupboolfalseno
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
familyRedis familystringn/ayes
id_length_limitLimit 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.
numbernullno
ingress_cidr_blocksCIDR blocks for permitted ingresslist(string)n/ayes
label_key_caseControls 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.
stringnullno
label_orderThe 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)nullno
label_value_caseControls 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.
stringnullno
labels_as_tagsSet 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
nameID 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.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
portPort numbernumbern/ayes
redis_clustersRedis cluster configurationmap(any)n/ayes
regex_replace_charsTerraform 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.
stringnullno
regionAWS regionstringn/ayes
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
transit_encryption_enabledEnable TLSbooln/ayes

Outputs

NameDescription
redis_clustersRedis cluster objects

References