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 Iam User

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-iam-user

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-iam-user.svg"
    url: "https://github.com/clouddrove/terraform-aws-iam-user/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-iam-user/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-iam-user/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 Iam user resource on AWS.

# How to use this project
usage : |-
  ### Simple example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
    module "iam-user" {
      source                  = "clouddrove/iam-user/aws"
      version                 = "1.3.0"
      name                    = "iam-user"
      environment             = "test"
      label_order             = ["name","environment"]
      policy_enabled          = true
      policy                  = data.aws_iam_policy_document.default.json
      password_length         = 20
      password_reset_required = true
    }

    data "aws_iam_policy_document" "default" {
      statement {
        actions = [
          "ec2:Describe*"
        ]
        effect    = "Allow"
        resources = ["*"]
      }
    }
  ```