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 DocumentDB

# License of this project
license: "APACHE"

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

# Badges to display
badges:
  - name: "Terraform"
    image: "https://img.shields.io/badge/Terraform-v1.1.7-green"
    url: "https://www.terraform.io"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-documentdb/actions/workflows/tfsec.yaml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-documentdb/actions/workflows/tfsec.yaml"
  - name: "static-checks"
    image: "https://github.com/clouddrove/terraform-aws-documentdb/actions/workflows/terraform.yaml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-documentdb/actions/workflows/terraform.yaml"
  - 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 documentdb 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 "documentdb" {
    source = "clouddrove/terraform-aws-documentdb/aws"
    vpc_id                = module.vpc.vpc_id
    subnet_list           = module.subnets.private_subnet_id
    database_name         = "rds"
    environment           = "test"
    label_order           = ["environment", "name"]
    master_username       = "db-user"  
    master_password       = "gfbaJpP00W0m413Bc1fe"
    instance_class        = "db.t3.medium"
    cluster_family        = "docdb5.0"  
    cluster_size          = 1
  }

    ```
  ### Secure Example
  ```hcl
  module "documentdb" {
    source = "clouddrove/terraform-aws-documentdb/aws"
    name                    = "documentdb"
    environment             = "test"
    label_order             = ["environment", "name"]
    vpc_id                  = module.vpc.vpc_id
    subnet_list             = module.subnets.private_subnet_id
    vpc_security_group_ids  = [module.security_group-documentdb.security_group_ids]
    database_name           = "test"
    master_username         = "db-user"  
    master_password         = "QfbaJpP00W0m413Bw1fe"  
    skip_final_snapshot     = false
    storage_encrypted       = true
    kms_key_id              = module.kms_key.key_arn
    tls_enabled             = true
    instance_class          = "db.t3.medium"
    cluster_family          = "docdb5.0"  
    cluster_size            = 2
    deletion_protection     = true
    preferred_backup_window = "07:00-07:30"
  }

    ```