terraform-aws-kvstores

Terraform module which creates kvstores backed by dynamodb and redis

Requirements

Name	Version
terraform	>= 1.3.0

Providers

No providers.

Modules

Name	Source	Version
kvstore	justtrackio/kvstore/aws	1.2.1
kvstore_label	justtrackio/label/null	0.26.0
this	justtrackio/label/null	0.26.0

Resources

No resources.

Inputs

Name	Description	Type	Default	Required
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
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
attributes_as_suffix	Attributes passed into the module are put in front of each.key (model name) by default. Setting this to true will put the attributes after the each.key.	bool	false	no
aws_account_id	AWS account id	string	null	no
aws_region	AWS region	string	null	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
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
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	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
kvstores	Kvstores to be created	map(object({ ddb = optional(object({ autoscaler = optional(object({ enabled = optional(bool, true) read_schedule = optional(list(object({ schedule = string min_capacity = number max_capacity = number })), []) write_schedule = optional(list(object({ schedule = string min_capacity = number max_capacity = number })), []) }), {}) billing_mode = optional(string, "PROVISIONED") }), {}) redis = object({ cpu_size = optional(number, 25), deployment = optional(object({ image = optional(object({ repository = optional(string, "redis") tag = optional(string, "7-alpine") }), {}) desired_count = optional(number, 1) maximum_percent = optional(number, 100) minimum_healthy_percent = optional(number, 0) }), {}) enabled = optional(bool, true), memory_size = optional(string, "25") service_discovery_name = optional(string, "") service_memory_size = optional(number, 50) service_placement_constraints = optional(set(object({ type = string expression = string })), []) }) }))	{}	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_orders	label orders as per cloudposse label module	object({ ddb = optional(list(string)) iam = optional(list(string)) redis = optional(list(string)) })	n/a	yes
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
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
organizational_unit	Usually used to indicate the AWS organizational unit, e.g. 'prod', 'sdlc'	string	null	no
redis_ecs_cluster_arn	Arn of the ecs cluster to spawn redis instances in (only required when kvstore.x.redis.enabled=true)	string	null	no
redis_launch_type	The launch type on which to run your service. Valid values are EC2 and FARGATE	string	"EC2"	no
redis_network_mode	The networking mode used for task, can be null or awsvpc	string	null	no
redis_propagate_tags	Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are SERVICE and TASK_DEFINITION	string	"SERVICE"	no
redis_service_discovery_dns_namespace_id	ID of the aws service discovery dns namespace (generated by the terraform-aws-ocean-ecs module, visible in Cloud Map)	string	n/a	yes
redis_vpc_id	ID of the aws vpc in which to spawn the redis service	string	null	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
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	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

Outputs

No outputs.