Module: `dynamodb`

Terraform module to provision a DynamoDB table with autoscaling.

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

Requirements

This module requires AWS Provider >= 4.22.0

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "dynamodb_table" {
  source = "cloudposse/dynamodb/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace                    = "eg"
  stage                        = "dev"
  name                         = "cluster"
  hash_key                     = "HashKey"
  range_key                    = "RangeKey"
  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
  enable_autoscaler            = true
}

Advanced Usage

With additional attributes, global secondary indexes and non_key_attributes (see examples/complete).

module "dynamodb_table" {
  source = "cloudposse/dynamodb/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace                    = "eg"
  stage                        = "dev"
  name                         = "cluster"
  hash_key                     = "HashKey"
  range_key                    = "RangeKey"
  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
  enable_autoscaler            = true

  dynamodb_attributes = [
    {
      name = "DailyAverage"
      type = "N"
    },
    {
      name = "HighWater"
      type = "N"
    },
    {
      name = "Timestamp"
      type = "S"
    }
  ]

  local_secondary_index_map = [
    {
      name               = "TimestampSortIndex"
      range_key          = "Timestamp"
      projection_type    = "INCLUDE"
      non_key_attributes = ["HashKey", "RangeKey"]
    },
    {
      name               = "HighWaterIndex"
      range_key          = "Timestamp"
      projection_type    = "INCLUDE"
      non_key_attributes = ["HashKey", "RangeKey"]
    }
  ]

  global_secondary_index_map = [
    {
      name               = "DailyAverageIndex"
      hash_key           = "DailyAverage"
      range_key          = "HighWater"
      write_capacity     = 5
      read_capacity      = 5
      projection_type    = "INCLUDE"
      non_key_attributes = ["HashKey", "RangeKey"]
    }
  ]

  replicas = ["us-east-1"]
}

NOTE: Variables "global_secondary_index_map" and "local_secondary_index_map" have a predefined schema, but in some cases not all fields are required or needed.

For example:

non_key_attributes can't be specified for Global Secondary Indexes (GSIs) when projection_type is ALL
read_capacity and write_capacity are not required for GSIs

In these cases, set the fields to null and Terraform will treat them as if they were not provided at all, but will not complain about missing values:

  global_secondary_index_map = [
    {
      write_capacity     = null
      read_capacity      = null
      projection_type    = "ALL"
      non_key_attributes = null
    }
  ]

See Terraform types and values for more details.

Variables

Required Variables

hash_key (string) required: DynamoDB table Hash Key

Optional Variables

autoscale_max_read_capacity (number) optional

DynamoDB autoscaling max read capacity

Default value: 20

autoscale_max_write_capacity (number) optional

DynamoDB autoscaling max write capacity

Default value: 20

autoscale_min_read_capacity (number) optional

DynamoDB autoscaling min read capacity

Default value: 5

autoscale_min_write_capacity (number) optional

DynamoDB autoscaling min write capacity

Default value: 5

autoscale_read_target (number) optional

The target value (in %) for DynamoDB read autoscaling

Default value: 50

autoscale_write_target (number) optional

The target value (in %) for DynamoDB write autoscaling

Default value: 50

autoscaler_attributes (list(string)) optional

Additional attributes for the autoscaler module

Default value: [ ]

autoscaler_tags (map(string)) optional

Additional resource tags for the autoscaler module

Default value: { }

billing_mode (string) optional

DynamoDB Billing mode. Can be PROVISIONED or PAY_PER_REQUEST

Default value: "PROVISIONED"

deletion_protection_enabled (bool) optional

Enable/disable DynamoDB table deletion protection

Default value: false

dynamodb_attributes optional

Additional DynamoDB attributes in the form of a list of mapped values

Type:

list(object({
name = string
type = string
}))

Default value: [ ]

enable_autoscaler (bool) optional

Flag to enable/disable DynamoDB autoscaling

Default value: false

enable_encryption (bool) optional

Enable DynamoDB server-side encryption

Default value: true

enable_point_in_time_recovery (bool) optional

Enable DynamoDB point in time recovery

Default value: true

enable_streams (bool) optional

Enable DynamoDB streams

Default value: false

global_secondary_index_map optional

Additional global secondary indexes in the form of a list of mapped values

Type:

list(object({
hash_key           = string
name               = string
non_key_attributes = list(string)
projection_type    = string
range_key          = string
read_capacity      = number
write_capacity     = number
}))

Default value: [ ]

hash_key_type (string) optional

Hash Key type, which must be a scalar type: S, N, or B for (S)tring, (N)umber or (B)inary data

Default value: "S"

import_table optional

Import Amazon S3 data into a new table.

Type:

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)
})
})

Default value: null

local_secondary_index_map optional

Additional local secondary indexes in the form of a list of mapped values

Type:

list(object({
name               = string
non_key_attributes = list(string)
projection_type    = string
range_key          = string
}))

Default value: [ ]

range_key (string) optional

DynamoDB table Range Key

Default value: ""

range_key_type (string) optional

Range Key type, which must be a scalar type: S, N, or B for (S)tring, (N)umber or (B)inary data

Default value: "S"

replicas (list(string)) optional

List of regions to create replica

Default value: [ ]

server_side_encryption_kms_key_arn (string) optional

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.

Default value: null

stream_view_type (string) optional

When an item in the table is modified, what information is written to the stream

Default value: ""

table_class (string) optional

DynamoDB storage class of the table. Can be STANDARD or STANDARD_INFREQUENT_ACCESS

Default value: "STANDARD"

table_name (string) optional

Table name. If provided, the bucket will be created with this name instead of generating the name from the context

Default value: null

tags_enabled (bool) optional

Set to false to disable tagging. This can be helpful if you're managing tables on dynamodb-local with terraform as it doesn't support tagging.

Default value: true

ttl_attribute (string) optional

DynamoDB table TTL attribute

Default value: "Expires"

ttl_enabled (bool) optional

Set to false to disable DynamoDB table TTL

Default value: true

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

global_secondary_index_names: DynamoDB secondary index names
local_secondary_index_names: DynamoDB local index names
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

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.59
null, version: >= 2.0

Providers

aws, version: >= 4.59
null, version: >= 2.0

Modules

Name	Version	Source	Description
`dynamodb_autoscaler`	0.16.0	`cloudposse/dynamodb-autoscaler/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_dynamodb_table.default (resource)
null_resource.global_secondary_index_names (resource)
null_resource.local_secondary_index_names (resource)

Data Sources

The following data sources are used by this module:

Module: dynamodb

Requirements​

Usage​

Advanced Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `dynamodb`

Requirements

Usage

Advanced Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources