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

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-dynamodb

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-dynamodb.svg"
    url: "https://github.com/clouddrove/terraform-aws-dynamodb/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-dynamodb/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-dynamodb/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

module_dependencies: 
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  description of this project
description: |-
  Terraform module to create dynamodb resource on AWS.

# How to use this project
# yamllint disable rule:line-length
usage: |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
    ```hcl
  module "dynamodb" {
  source      = "clouddrove/terraform-aws-dynamodb/aws"
  version     = "1.0.1"
  name        = "dynamodb"
  environment = "test"
  label_order = ["environment", "name"]
  hash_key    = "HashKey"
  range_key   = "RangeKey"

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

  #autoscaler
  enable_autoscaler = true
  dynamodb_indexes  = ["DailyAverageIndex"]

  #enable replica and streams
  enable_streams   = true
  stream_view_type = "KEYS_ONLY"
  }

    ```