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.

Usage

module "dynamodb_table" {
  source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
  namespace                    = "cp"
  stage                        = "dev"
  name                         = "cluster"
  hash_key                     = "HashKey"
  range_key                    = "RangeKey"
  autoscale_write_target       = 10
  autoscale_read_target        = 10
  autoscale_min_read_capacity  = 5
  autoscale_max_read_capacity  = 20
  autoscale_min_write_capacity = 5
  autoscale_max_write_capacity = 20
  enable_autoscaler            = "true"
}

Variables

Name	Default	Description	Required
`namespace`	``	Namespace (e.g. `cp` or `cloudposse`)	Yes
`stage`	``	Stage (e.g. `prod`, `dev`, `staging`)	Yes
`name`	``	Name (e.g. `app` or `cluster`)	Yes
`hash_key`	``	DynamoDB table Hash Key	Yes
`range_key`	``	DynamoDB table Range Key	Yes
`ttl_attribute`	``	DynamoDB table TTL attribute	No
`enable_encryption`	`true`	Enable DynamoDB server-side encryption	No
`attributes`	`[]`	Additional attributes (e.g. `policy` or `role`)	No
`tags`	`{}`	Additional tags (e.g. `map("BusinessUnit","XYZ")`	No
`delimiter`	`-`	Delimiter to be used between `namespace`, `stage`, `name`, and `attributes`	No
`autoscale_write_target`	`10`	The target value for DynamoDB write autoscaling	No
`autoscale_read_target`	`10`	The target value for DynamoDB read autoscaling	No
`autoscale_min_read_capacity`	`5`	DynamoDB autoscaling min read capacity	No
`autoscale_max_read_capacity`	`20`	DynamoDB autoscaling max read capacity	No
`autoscale_min_write_capacity`	`5`	DynamoDB autoscaling min write capacity	No
`autoscale_max_write_capacity`	`20`	DynamoDB autoscaling max write capacity	No
`enable_autoscaler`	`true`	Flag to enable/disable DynamoDB autoscaling	No

Outputs

Name	Description
`table_id`	DynamoDB table ID
`table_arn`	DynamoDB table ARN
`table_name`	DynamoDB table name

Help

Got a question?

File a GitHub issue, send us an email or reach out to us on Gitter.

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 terraform-aws-dynamodb, 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 from "upstream" before making a pull request!

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

  http://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.