terraform-aws-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 >= 1.17.0

---

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

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                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
  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                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
  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"]
    }
  ]
}

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.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 0.12.0
aws	>= 2.0
null	~> 2.0

Providers

Name	Version
aws	>= 2.0
null	~> 2.0

Inputs

Name	Description	Type	Default	Required
attributes	Additional attributes (e.g. 1)	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
billing_mode	DynamoDB Billing mode. Can be PROVISIONED or PAY_PER_REQUEST	string	"PROVISIONED"	no
delimiter	Delimiter to be used between namespace, environment, stage, name and attributes	string	"-"	no
dynamodb_attributes	Additional DynamoDB attributes in the form of a list of mapped values	list(object({ name = string type = string }))	[]	no
enable_autoscaler	Flag to enable/disable DynamoDB autoscaling	bool	false	no
enable_encryption	Enable DynamoDB server-side encryption	bool	true	no
enable_point_in_time_recovery	Enable DynamoDB point in time recovery	bool	true	no
enable_streams	Enable DynamoDB streams	bool	false	no
enabled	Set to false to prevent the module from creating any resources	bool	true	no
environment	Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT'	string	""	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 (S)tring, (N)umber or (B)inary data	string	"S"	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	Solution name, e.g. 'app' or 'jenkins'	string	""	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	string	""	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 (S)tring, (N)umber or (B)inary data	string	"S"	no
regex_replace_chars	Regex to replace chars with empty string in namespace, environment, stage and name. By default only hyphens, letters and digits are allowed, all other chars are removed	string	"/[^a-zA-Z0-9-]/"	no
stage	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	string	""	no
stream_view_type	When an item in the table is modified, what information is written to the stream	string	""	no
tags	Additional tags (e.g. map('BusinessUnit','XYZ')	map(string)	{}	no
ttl_attribute	DynamoDB table TTL attribute	string	"Expires"	no

Outputs

Name	Description
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

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

• terraform-aws-dynamodb-autoscaler - Terraform module to provision DynamoDB autoscaler
• terraform-aws-tfstate-backend - Provision an S3 bucket to store terraform.tfstate file and a DynamoDB table to lock the state file to prevent concurrent modifications and state corruption
• terraform-aws-elasticache-redis - Terraform module to provision an ElastiCache Redis Cluster
• terraform-aws-elasticache-memcached - Terraform Module for ElastiCache Memcached Cluster
• terraform-aws-elasticache-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for ElastiCache
• terraform-aws-rds-cluster - Terraform module to provision an RDS Aurora cluster for MySQL or Postgres
• terraform-aws-rds - Terraform module to provision AWS RDS instances

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
• Site Reliability Engineering. You'll have total visibility into your apps and microservices.
• Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
• GitOps. You'll be able to operate your infrastructure via Pull Requests.
• Training. You'll receive hands-on training so your team can operate what we build.
• Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
• Troubleshooting. You'll get help to triage when things aren't working.
• Code Reviews. You'll receive constructive feedback on Pull Requests.
• Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2020 Cloud Posse, LLC

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman	Andriy Knysh	Jamie Nelson	Daren Desjardins	Maarten van der Hoef