terraform-aws-kvstore

Terraform module which creates a kvstore backed by dynamodb and redis

Requirements

Name	Version
terraform	>= 1.3.0

Providers

No providers.

Modules

Name	Source	Version
ddb	justtrackio/dynamodb-table/aws	2.0.2
kvstore_label	justtrackio/label/null	0.26.0
redis	justtrackio/ecs-redis/aws	2.2.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
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
ddb_autoscaling_enabled	Whether or not to enable autoscaling. See note in README about this setting	bool	true	no
ddb_autoscaling_read	A map of read autoscaling settings. max_capacity is the only required key. See example in examples/autoscaling	map(string)	null	no
ddb_autoscaling_write	A map of write autoscaling settings. max_capacity is the only required key. See example in examples/autoscaling	map(string)	null	no
ddb_billing_mode	The billing mode for the DDB table	string	"PROVISIONED"	no
ddb_enabled	For creating a dynamodb table	bool	true	no
ddb_read_capacity	The number of read units for this table. If the billing_mode is PROVISIONED, this field should be greater than 0	number	null	no
ddb_schedule_scaling_read	A map of read schedule scaling settings. See example in examples/autoscaling	list(object({ schedule = string min_capacity = number max_capacity = number }))	[]	no
ddb_schedule_scaling_write	A map of write schedule scaling settings. See example in examples/autoscaling	list(object({ schedule = string min_capacity = number max_capacity = number }))	[]	no
ddb_write_capacity	The number of write units for this table. If the billing_mode is PROVISIONED, this field should be greater than 0	number	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
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	Overrides the labels_order for the different labels to modify ID elements appear in the id	object({ ecs = optional(list(string), ["stage", "tenant", "name"]) iam = optional(list(string), ["environment", "stage", "tenant", "name", "attributes"]), kvstore = optional(list(string), ["environment", "stage", "tenant", "name"]) })	{}	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
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_cpu_size	The cpu size of the redis instance	number	25	no
redis_deployment_maximum_percent	The upper limit of the number of tasks (as a percentage of desired_count) that can be running in a service during a deployment	number	100	no
redis_deployment_minimum_healthy_percent	The lower limit (as a percentage of desired_count) of the number of tasks that must remain running and healthy in a service during a deployment	number	0	no
redis_enabled	For creating a redis service	bool	true	no
redis_image_repository	Redis image repository to use when use_redis is true	string	"redis"	no
redis_image_tag	Redis image tag to use when use_redis is true	string	"7-alpine"	no
redis_maxmemory	The memory size of the redis instance	number	25	no
redis_maxmemory_policy	When your Redis instance memory is full, and a new write comes in, Redis evicts keys to make room for the write based on your instance's maxmemory policy.	string	"allkeys-lru"	no
redis_memory_size	The memory size of the ECS container	number	50	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

Name	Description
redis_service_discovery_service_arn	ARN of the aws_service_discovery_service created for the redis service