Module: dynamodb-autoscaler

Terraform module to provision DynamoDB autoscaler.

Autoscaler scales up/down the provisioned OPS for a DynamoDB table based on the load.

Usage

module "dynamodb_autoscaler" {
  source = "cloudposse/dynamodb-autoscaler/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace                    = "eg"
  stage                        = "dev"
  name                         = "cluster"
  dynamodb_table_name          = "eg-dev-cluster-terraform-state-lock"
  dynamodb_indexes             = ["first-index", "second-index"]
  dynamodb_table_arn           = "arn:aws:dynamodb:us-east-1:123456789012:table/eg-dev-cluster-terraform-state-lock"
  autoscale_write_target       = 50
  autoscale_read_target        = 50
  autoscale_min_read_capacity  = 5
  autoscale_max_read_capacity  = 20
  autoscale_min_write_capacity = 5
  autoscale_max_write_capacity = 20
  autoscale_scale_in_cooldown  = null  # defaults to AWS's default
  autoscale_scale_out_cooldown = null  # defaults to AWS's default
}

Requirements

Name	Version
terraform	>= 1.0
aws	>= 2.0
null	>= 2.0

Providers

Name	Version
aws	>= 2.0

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_appautoscaling_policy.read_policy	resource
aws_appautoscaling_policy.read_policy_index	resource
aws_appautoscaling_policy.write_policy	resource
aws_appautoscaling_policy.write_policy_index	resource
aws_appautoscaling_target.read_target	resource
aws_appautoscaling_target.read_target_index	resource
aws_appautoscaling_target.write_target	resource
aws_appautoscaling_target.write_target_index	resource

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
autoscale_max_read_capacity	DynamoDB autoscaling max read capacity	number	20	no
autoscale_max_read_capacity_index	DynamoDB autoscaling max read capacity of the index	number	null	no
autoscale_max_write_capacity	DynamoDB autoscaling max write capacity	number	20	no
autoscale_max_write_capacity_index	DynamoDB autoscaling max write capacity of the index	number	null	no
autoscale_min_read_capacity	DynamoDB autoscaling min read capacity	number	5	no
autoscale_min_read_capacity_index	DynamoDB autoscaling min read capacity of the index	number	null	no
autoscale_min_write_capacity	DynamoDB autoscaling min write capacity	number	5	no
autoscale_min_write_capacity_index	DynamoDB autoscaling min write capacity of the index	number	null	no
autoscale_read_target	The target value for DynamoDB read autoscaling	number	50	no
autoscale_read_target_index	The target value for DynamoDB read autoscaling of the index	number	null	no
autoscale_scale_in_cooldown	DynamoDB autoscaling scale in cooldown	number	null	no
autoscale_scale_out_cooldown	DynamoDB autoscaling scale out cooldown	number	null	no
autoscale_write_target	The target value for DynamoDB write autoscaling	number	50	no
autoscale_write_target_index	The target value for DynamoDB write autoscaling of the index	number	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
dynamodb_indexes	List of DynamoDB indexes	list(string)	[]	no
dynamodb_table_arn	DynamoDB table ARN	string	n/a	yes
dynamodb_table_name	DynamoDB table name	string	n/a	yes
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_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
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
appautoscaling_read_policy_arn	Appautoscaling read policy ARN
appautoscaling_write_policy_arn	Appautoscaling write policy ARN