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

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"
    },
  ]

  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"]
    },
    {
      name            = "HighWaterIndex"
      hash_key        = "HighWater"
      write_capacity  = 5
      read_capacity   = 5
      projection_type = "KEYS_ONLY"
    },
  ]
}

Makefile Targets

Available targets:

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

Inputs

Name	Description	Type	Default	Required
attributes	Additional attributes (e.g. `policy` or `role`)	list	`<list>`	no
autoscale_max_read_capacity	DynamoDB autoscaling max read capacity	string	`20`	no
autoscale_max_write_capacity	DynamoDB autoscaling max write capacity	string	`20`	no
autoscale_min_read_capacity	DynamoDB autoscaling min read capacity	string	`5`	no
autoscale_min_write_capacity	DynamoDB autoscaling min write capacity	string	`5`	no
autoscale_read_target	The target value (in %) for DynamoDB read autoscaling	string	`50`	no
autoscale_write_target	The target value (in %) for DynamoDB write autoscaling	string	`50`	no
delimiter	Delimiter to be used between `namespace`, `stage`, `name`, and `attributes`	string	`-`	no
dynamodb_attributes	Additional DynamoDB attributes in the form of a list of mapped values	list	`<list>`	no
enable_autoscaler	Flag to enable/disable DynamoDB autoscaling	string	`true`	no
enable_encryption	Enable DynamoDB server-side encryption	string	`true`	no
enable_point_in_time_recovery	Enable DynamoDB point in time recovery	string	`true`	no
enable_streams	Enable DynamoDB streams	string	`false`	no
global_secondary_index_map	Additional global secondary indexes in the form of a list of mapped values	list	`<list>`	no
hash_key	DynamoDB table Hash Key	string	-	yes
local_secondary_index_map	Additional local secondary indexes in the form of a list of mapped values	list	`<list>`	no
name	Name (e.g. `app` or `cluster`)	string	-	yes
namespace	Namespace (e.g. `eg` or `cp`)	string	-	yes
range_key	DynamoDB table Range Key	string	``	no
stage	Stage (e.g. `prod`, `dev`, `staging`, `infra`)	string	-	yes
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	`<map>`	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?

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

Commercial Support

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

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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.

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

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.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
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

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

neoshadybeat / terraform-aws-dynamodb

terraform-aws-dynamodb

Requirements

Usage

Advanced Usage

Makefile Targets

Inputs

Outputs

Share the Love

Related Projects

Help

Commercial Support

Terraform Module Development

Slack Community

Newsletter

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors

About

Languages