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 Secrets Manager

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-secrets-manager

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-secrets-manager.svg"
    url: "https://github.com/clouddrove/terraform-aws-secrets-manager/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-secrets-manager/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-secrets-manager/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
# yamllint disable rule:line-length
description: |-
  Terraform module to create an Secrets Manager resource on AWS .

# extra content
include:
  - "terraform.md"

# How to use this project
# yamllint disable rule:line-length
usage: |-
  Here is examples of how you can use this module in your inventory structure:
  ### Binary Example
  ```hcl
    module "secrets_manager" {

    source      = "clouddrove/secrets_manager/aws"
    version     = "2.0.0"
    name        = "secrets-manager"
    environment = "test"
    label_order = ["name", "environment"]

    secrets = [
    {
    name          = "secret-binary-1"
    description   = "This is a binary secret"
    secret_binary = "ssh-rsa /+ZHJ4gx0gB8yQ/JWPhG1Xi2AWrMqfkidHOh5cp/H+/vSgD47xHID0JqOOugkN96fBY4/PbvoI6UfPFDGQxfE7LaqGsPf2QZcEJlYxK3f+io/uHDKrq6Q5KnZw2+DdsBxuDfM1BlJqoWRfmcB9wKPWBvm9xMUVm8T2BIcwWikgNuzssy6p63ab7HOzCyl4i7y8V4v8ouIHDM5QA29oVLHz40Nc0JS6ahVQta4JEOHUTf3hgvw9vCAWyyjlJScLSPyQtLXTuBh2FbtG9YouiDv1SszFHStYPvWdq+6CQY5bWfzqyVXZ9lqQhHUkOaW0FJbGGfBMmwQ5WO15925OF53YgtltwSBb9SIF4k9fHjDJ9YUr4bSiIB6oDwoJmWGjS9eI8pxdTAgJ4+IXj+F/Q+AxtDiRsSUKRp2EhIoxxpy+xXMZjGyMDCSLtntzu8yF3SMiZewpR7dWZ8PzDWY7hei3M6kH6BNAy0SX9GRbT3JwGar3OilqZOoCfjjDcakgFDc1vcZnHwBarXnXP520D1hXxP+TCiemAhcFugp7FHAQdhs4+cYk3hJexpU3+SQxizoSkmd7JszO5YlJUtd9k93Q4wWnTk4rmukIJWFsGX8R9Uhb14J0mWDZAvuldnpaO3ASInl2o7r8CvQGcAavnAhBOWHs6AoSUX4ZMG0pk41sM7r7EgKsPG2J5aCpnI9Ht1od7UGaCBtcQv2yZVWrGT1yRJVwGi5Fk+IemFqbIzd5I1HldZvouvQ7Qy5Ezba2y8aYbKY9bvA4nqcCH9eA38671+Ykho/3LpZ5tLt120XGnBfMhMqNtHewzhtdv4y39iEFa+AFa5MXxx7uJe5EcoT/z3WXGIWaC9oIOLpedhsrDyKOvrzwcQ3r+PF6cZuskAaM0j/DgAVmwFke0Iqz2Blq6BnDBmTzXS5yOqr2jebNbFQq3btM6m5zUYTRFkJ/fYBL8nujkPJtE2b1PFIPKX2SDMhIlLcH9SKxlAOxzmF7xu0LsAQENtSawcm3rIZzuBJsV2IlaBuAPP2c01k6upc6VXoMScWZ3a/RZTfmRLPiumkrsmL5xTyK8P4qohUGzPAXWz8Aq0GrHjbu7MPveXiVstFBhtVzeq5G4O2A+BqIu9Paq/lKF9AhQEaM6Ipjo8fTQ1yJIjjj6mCyL51b1cLd7NsKh50WCJBYArhV+5uUTxw9Qih+nvITHoF7q8lNfigVMaACbWqHpE0kMGPqNXhXhtXPhTkMoc4BPBS4aBaVdFqrp6cxGwVsfHOrsk8L1gzuOu8ovjgBfNdcdHGFB4D9joJ test-ssh-key"
    },
    {
    name                    = "secret-binary-2"
    description             = "Another binary secret"
    secret_binary           = "ssh-rsa /+ZHJ4gx0gB8yQ/JWPhG1Xi2AWrMqfkidHOh5cp/H+/vSgD47xHID0JqOOugkN96fBY4/PbvoI6UfPFDGQxfE7LaqGsPf2QZcEJlYxK3f+io/uHDKrq6Q5KnZw2+DdsBxuDfM1BlJqoWRfmcB9wKPWBvm9xMUVm8T2BIcwWikgNuzssy6p63ab7HOzCyl4i7y8V4v8ouIHDM5QA29oVLHz40Nc0JS6ahVQta4JEOHUTf3hgvw9vCAWyyjlJScLSPyQtLXTuBh2FbtG9YouiDv1SszFHStYPvWdq+6CQY5bWfzqyVXZ9lqQhHUkOaW0FJbGGfBMmwQ5WO15925OF53YgtltwSBb9SIF4k9fHjDJ9YUr4bSiIB6oDwoJmWGjS9eI8pxdTAgJ4+IXj+F/Q+AxtDiRsSUKRp2EhIoxxpy+xXMZjGyMDCSLtntzu8yF3SMiZewpR7dWZ8PzDWY7hei3M6kH6BNAy0SX9GRbT3JwGar3OilqZOoCfjjDcakgFDc1vcZnHwBarXnXP520D1hXxP+TCiemAhcFugp7FHAQdhs4+cYk3hJexpU3+SQxizoSkmd7JszO5YlJUtd9k93Q4wWnTk4rmukIJWFsGX8R9Uhb14J0mWDZAvuldnpaO3ASInl2o7r8CvQGcAavnAhBOWHs6AoSUX4ZMG0pk41sM7r7EgKsPG2J5aCpnI9Ht1od7UGaCBtcQv2yZVWrGT1yRJVwGi5Fk+IemFqbIzd5I1HldZvouvQ7Qy5Ezba2y8aYbKY9bvA4nqcCH9eA38671+Ykho/3LpZ5tLt120XGnBfMhMqNtHewzhtdv4y39iEFa+AFa5MXxx7uJe5EcoT/z3WXGIWaC9oIOLpedhsrDyKOvrzwcQ3r+PF6cZuskAaM0j/DgAVmwFke0Iqz2Blq6BnDBmTzXS5yOqr2jebNbFQq3btM6m5zUYTRFkJ/fYBL8nujkPJtE2b1PFIPKX2SDMhIlLcH9SKxlAOxzmF7xu0LsAQENtSawcm3rIZzuBJsV2IlaBuAPP2c01k6upc6VXoMScWZ3a/RZTfmRLPiumkrsmL5xTyK8P4qohUGzPAXWz8Aq0GrHjbu7MPveXiVstFBhtVzeq5G4O2A+BqIu9Paq/lKF9AhQEaM6Ipjo8fTQ1yJIjjj6mCyL51b1cLd7NsKh50WCJBYArhV+5uUTxw9Qih+nvITHoF7q8lNfigVMaACbWqHpE0kMGPqNXhXhtXPhTkMoc4BPBS4aBaVdFqrp6cxGwVsfHOrsk8L1gzuOu8ovjgBfNdcdHGFB4D9joJ test-ssh-key-2"
    recovery_window_in_days = 7
      }
       ]
    }
  ```

  ### Key-value
  ```hcl
     module "secrets_manager" {

    source      = "clouddrove/secrets_manager/aws"
    version     = "2.0.0"
    name        = "secrets-manager"
    environment = "test"
    label_order = ["name", "environment"]

    secrets = [
    {
    name        = "secret-kv-1"
    description = "This is a key/value secret"

    secret_key_value = {
    key1  = "value1"
    key2  = "value2"
    key3  = "value2"
    key4  = "value2"
    key5  = "value2"
    key6  = "value2"
    key7  = "value2"
    key8  = "value2"
    key89 = "value2"

  }
    recovery_window_in_days = 7
    },
    {
    name        = "secret-kv-2"
    description = "Another key/value secret"

    secret_key_value = {
    username = "user"
    password = "topsecret"
    }
    recovery_window_in_days = 7
    },
    ]



  }
  ```

  ### plaintext
  ```hcl
    module "secrets_manager" {

    source      = "clouddrove/secrets_manager/aws"
    version   = "2.0.0"
    name        = "secrets-manager"
    environment = "test"
    label_order = ["name", "environment"]

    secrets = [
    {
    name                    = "secret-1"
    description             = "My secret 1"
    recovery_window_in_days = 7
    secret_string           = "This is an example"
    },
    {
    name                    = "secret-2"
    description             = "My secret 2"
    recovery_window_in_days = 7
    secret_string           = "This is another example"
    }
    ]
  }
  ```