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: "APACHE2"

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

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-iam-user.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-iam-user/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-iam-user.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-iam-user/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-aws-iam-assumed-roles"
    description: "Terraform Module for Assumed Roles on AWS with IAM Groups Requiring MFA"
    url: "https://github.com/cloudposse/terraform-aws-iam-assumed-roles"
  - name: "terraform-aws-iam-s3-user"
    description: "Terraform module to provision a basic IAM user with permissions to access S3 resources, e.g. to give the user read/write/delete access to the objects in an S3 bucket"
    url: "https://github.com/cloudposse/terraform-aws-iam-s3-user"
  - name: "terraform-aws-organization-access-group"
    description: "Terraform module to create an IAM Group and Policy to grant permissions to delegated IAM users in the Organization's master account to access a member account"
    url: "https://github.com/cloudposse/terraform-aws-organization-access-group"
  - name: "terraform-aws-ssm-iam-role"
    description: "Terraform module to provision an IAM role with configurable permissions to access SSM Parameter Store"
    url: "https://github.com/cloudposse/terraform-aws-ssm-iam-role"
  - name: "terraform-aws-iam-chamber-user"
    description: "Terraform module to provision a basic IAM chamber user with access to SSM parameters and KMS key to decrypt secrets, suitable for CI/CD systems (e.g. TravisCI, CircleCI, CodeFresh) or systems which are external to AWS that cannot leverage AWS IAM Instance Profiles"
    url: "https://github.com/cloudposse/terraform-aws-iam-chamber-user"
  - name: "terraform-aws-lb-s3-bucket"
    description: "Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs"
    url: "https://github.com/cloudposse/terraform-aws-lb-s3-bucket"

# Short description of this project
description: |-
  Terraform Module to provision a basic IAM user suitable for humans. It will establish a login profile and associate the user with IAM groups. 

  We do not recommend creating IAM users for any other purpose. For external systems (e.g. CI/CD) check out our [`terraform-aws-iam-system-user`](https://github.com/cloudposse/terraform-aws-iam-system-user) module.

# How to use this project
usage: |2-

  First, make sure all users register with [keybase.io](https://keybase.io) to faciliate public key encryption (PKE). 
  Then use their keybase username to automatically encrypt their AWS secret. It's that easy!


  ```hcl
  module "jack" {
    source = "cloudposse/iam-user/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
    name       = "jack"
    user_name  = "jack@companyname.com"
    pgp_key    = "keybase:jack"
    groups     = ["admins"]
  }
  ```
  __NOTE:__ We recommend using email addresses for IAM user accounts.

examples: |-
  ```hcl
  module "jill" {
    source = "cloudposse/iam-user/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
    name      = "jill"
    user_name  = "jill@companyname.com"
    pgp_key    = "keybase:jill"
    groups    = ["engineering"]
  }
  ```

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []