Skip to main content

Component: dynamodb

This component is responsible for provisioning a DynamoDB table.


Stack Level: Regional

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

workspace_key_prefix: dynamodb
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


terraform>= 1.0.0
aws>= 4.9.0


No providers.




No resources.


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.
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.
autoscale_max_read_capacityDynamoDB autoscaling max read capacitynumber20no
autoscale_max_write_capacityDynamoDB autoscaling max write capacitynumber20no
autoscale_min_read_capacityDynamoDB autoscaling min read capacitynumber5no
autoscale_min_write_capacityDynamoDB autoscaling min write capacitynumber5no
autoscale_read_targetThe target value (in %) for DynamoDB read autoscalingnumber50no
autoscale_write_targetThe target value (in %) for DynamoDB write autoscalingnumber50no
autoscaler_attributesAdditional attributes for the autoscaler modulelist(string)[]no
autoscaler_enabledFlag to enable/disable DynamoDB autoscalingboolfalseno
autoscaler_tagsAdditional resource tags for the autoscaler modulemap(string){}no
billing_modeDynamoDB Billing mode. Can be PROVISIONED or PAY_PER_REQUESTstring"PROVISIONED"no
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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
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).
dynamodb_attributesAdditional DynamoDB attributes in the form of a list of mapped values
name = string
type = string
enabledSet to false to prevent the module from creating any resourcesboolnullno
encryption_enabledEnable DynamoDB server-side encryptionbooltrueno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
global_secondary_index_mapAdditional global secondary indexes in the form of a list of mapped values
hash_key = string
name = string
non_key_attributes = list(string)
projection_type = string
range_key = string
read_capacity = number
write_capacity = number
hash_keyDynamoDB table Hash Keystringn/ayes
hash_key_typeHash Key type, which must be a scalar type: S, N, or B for String, Number or Binary data, respectively.string"S"no
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.
import_tableImport Amazon S3 data into a new table.
# 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)
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.
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.
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.
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.
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.
local_secondary_index_mapAdditional local secondary indexes in the form of a list of mapped values
name = string
non_key_attributes = list(string)
projection_type = string
range_key = string
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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
point_in_time_recovery_enabledEnable DynamoDB point in time recoverybooltrueno
range_keyDynamoDB table Range Keystring""no
range_key_typeRange Key type, which must be a scalar type: S, N, or B for String, Number or Binary data, respectively.string"S"no
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.
regionAWS Region.stringn/ayes
replicasList of regions to create a replica table inlist(string)[]no
server_side_encryption_kms_key_arnThe 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.stringnullno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
stream_view_typeWhen an item in the table is modified, what information is written to the streamstring""no
streams_enabledEnable DynamoDB streamsboolfalseno
table_nameTable name. If provided, the bucket will be created with this name instead of generating the name from the contextstringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
ttl_attributeDynamoDB table TTL attributestring""no
ttl_enabledSet to false to disable DynamoDB table TTLboolfalseno


global_secondary_index_namesDynamoDB global secondary index names
hash_keyDynamoDB table hash key
local_secondary_index_namesDynamoDB local secondary index names
range_keyDynamoDB table range key
table_arnDynamoDB table ARN
table_idDynamoDB table ID
table_nameDynamoDB table name
table_stream_arnDynamoDB table stream ARN
table_stream_labelDynamoDB table stream label