tags
component/dynamodb layer/data layer/gitops provider/aws

Component: dynamodb

This component is responsible for provisioning a DynamoDB table.

Usage

Stack Level: Regional

Here is an example snippet for how to use this component:

components:
  terraform:
    dynamodb:
      backend:
        s3:
          workspace_key_prefix: dynamodb
      vars:
        enabled: true
        hash_key: HashKey
        range_key: RangeKey
        billing_mode: PAY_PER_REQUEST
        autoscaler_enabled: false
        encryption_enabled: true
        point_in_time_recovery_enabled: true
        streams_enabled: false
        ttl_enabled: false

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.9.0

Providers

No providers.

Modules

Name	Source	Version
dynamodb_table	cloudposse/dynamodb/aws	0.36.0
iam_roles	../account-map/modules/iam-roles	n/a
this	cloudposse/label/null	0.25.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
autoscale_max_read_capacity	DynamoDB autoscaling max read capacity	number	20	no
autoscale_max_write_capacity	DynamoDB autoscaling max write capacity	number	20	no
autoscale_min_read_capacity	DynamoDB autoscaling min read capacity	number	5	no
autoscale_min_write_capacity	DynamoDB autoscaling min write capacity	number	5	no
autoscale_read_target	The target value (in %) for DynamoDB read autoscaling	number	50	no
autoscale_write_target	The target value (in %) for DynamoDB write autoscaling	number	50	no
autoscaler_attributes	Additional attributes for the autoscaler module	list(string)	[]	no
autoscaler_enabled	Flag to enable/disable DynamoDB autoscaling	bool	false	no
autoscaler_tags	Additional resource tags for the autoscaler module	map(string)	{}	no
billing_mode	DynamoDB Billing mode. Can be PROVISIONED or PAY_PER_REQUEST	string	"PROVISIONED"	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
deletion_protection_enabled	Enable/disable DynamoDB table deletion protection	bool	false	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_attributes	Additional DynamoDB attributes in the form of a list of mapped values	list(object({ name = string type = string }))	[]	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
encryption_enabled	Enable DynamoDB server-side encryption	bool	true	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
global_secondary_index_map	Additional global secondary indexes in the form of a list of mapped values	list(object({ hash_key = string name = string non_key_attributes = list(string) projection_type = string range_key = string read_capacity = number write_capacity = number }))	[]	no
hash_key	DynamoDB table Hash Key	string	n/a	yes
hash_key_type	Hash Key type, which must be a scalar type: S, N, or B for String, Number or Binary data, respectively.	string	"S"	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
import_table	Import Amazon S3 data into a new table.	object({ # Valid values are GZIP, ZSTD and NONE input_compression_type = optional(string, null) # Valid values are CSV, DYNAMODB_JSON, and ION. input_format = string input_format_options = optional(object({ csv = object({ delimiter = string header_list = list(string) }) }), null) s3_bucket_source = object({ bucket = string bucket_owner = optional(string) key_prefix = optional(string) }) })	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
local_secondary_index_map	Additional local secondary indexes in the form of a list of mapped values	list(object({ name = string non_key_attributes = list(string) projection_type = string range_key = string }))	[]	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
point_in_time_recovery_enabled	Enable DynamoDB point in time recovery	bool	true	no
range_key	DynamoDB table Range Key	string	""	no
range_key_type	Range Key type, which must be a scalar type: S, N, or B for String, Number or Binary data, respectively.	string	"S"	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
region	AWS Region.	string	n/a	yes
replicas	List of regions to create a replica table in	list(string)	[]	no
server_side_encryption_kms_key_arn	The ARN of the CMK that should be used for the AWS KMS encryption. This attribute should only be specified if the key is different from the default DynamoDB CMK, alias/aws/dynamodb.	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
stream_view_type	When an item in the table is modified, what information is written to the stream	string	""	no
streams_enabled	Enable DynamoDB streams	bool	false	no
table_name	Table name. If provided, the bucket will be created with this name instead of generating the name from the context	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
ttl_attribute	DynamoDB table TTL attribute	string	""	no
ttl_enabled	Set to false to disable DynamoDB table TTL	bool	false	no

Outputs

Name	Description
global_secondary_index_names	DynamoDB global secondary index names
hash_key	DynamoDB table hash key
local_secondary_index_names	DynamoDB local secondary index names
range_key	DynamoDB table range key
table_arn	DynamoDB table ARN
table_id	DynamoDB table ID
table_name	DynamoDB table name
table_stream_arn	DynamoDB table stream ARN
table_stream_label	DynamoDB table stream label

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component