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 Role

# License of this project
license: "APACHE"

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

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-iam-role.svg"
    url: "https://github.com/clouddrove/terraform-aws-iam-role/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-iam-role/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-iam-role/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 role 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 "iam-role" {
        source              = "clouddrove/iam-role/aws"
        name               = local.name
        environment        = local.environment
        assume_role_policy = data.aws_iam_policy_document.default.json
        policy_enabled     = true
        policy             = data.aws_iam_policy_document.iam-policy.json
      }

      ##-----------------------------------------------------------------------------
      ## Data block to create IAM policy.
      ##-----------------------------------------------------------------------------
      data "aws_iam_policy_document" "default" {
        statement {
        effect  = "Allow"
        actions = ["sts:AssumeRole"]
        principals {
        type        = "Service"
        identifiers = ["ec2.amazonaws.com"]
        }
        }
      }

      ##-----------------------------------------------------------------------------
      ## Data block to create IAM policy.
      ##-----------------------------------------------------------------------------
      data "aws_iam_policy_document" "iam-policy" {
        statement {
        actions = [
        "ssm:UpdateInstanceInformation",
        "ssmmessages:CreateControlChannel",
        "ssmmessages:CreateDataChannel",
        "ssmmessages:OpenControlChannel",
        "ssmmessages:OpenDataChannel"]
        effect    = "Allow"
        resources = ["*"]
        }
      }
  ```