README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-dynamodb-autoscaler
# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - databases
  - autoscaling
  - dynamodb
  - dynamodb-table
  - dynamodb-database
  - iops
  - table
# Categories of this project
categories:
  - terraform-modules/databases
# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-dynamodb-autoscaler
# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-dynamodb-autoscaler.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-dynamodb-autoscaler.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-aws-dynamodb"
    description: "Terraform module that implements AWS DynamoDB with support for AutoScaling"
    url: "https://github.com/cloudposse/terraform-aws-dynamodb"
  - name: "terraform-aws-tfstate-backend"
    description: "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"
    url: "https://github.com/cloudposse/terraform-aws-tfstate-backend"
# Short description of this project
description: |-
  Terraform module to provision DynamoDB autoscaler.

  Autoscaler scales up/down the provisioned OPS for a DynamoDB table based on the load.
# How to use this project
usage: |-
  ```hcl
  module "dynamodb_autoscaler" {
    source = "cloudposse/dynamodb-autoscaler/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
    namespace                    = "eg"
    stage                        = "dev"
    name                         = "cluster"
    dynamodb_table_name          = "eg-dev-cluster-terraform-state-lock"
    dynamodb_indexes             = ["first-index", "second-index"]
    dynamodb_table_arn           = "arn:aws:dynamodb:us-east-1:123456789012:table/eg-dev-cluster-terraform-state-lock"
    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
    autoscale_scale_in_cooldown  = null  # defaults to AWS's default
    autoscale_scale_out_cooldown = null  # defaults to AWS's default
  }
  ```
include:
  - "docs/targets.md"
  - "docs/terraform.md"
# Contributors to this project
contributors: []