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-chamber-user

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

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

# Badges to display
badges:
  - name: "Build Status"
    image: "https://travis-ci.org/cloudposse/terraform-aws-iam-chamber-user.svg?branch=master"
    url: "https://travis-ci.org/cloudposse/terraform-aws-iam-chamber-user"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-iam-chamber-user.svg"
    url: "https://github.com/cloudposse/terraform-aws-iam-chamber-user/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-iam-system-user"
    description: "Terraform Module to Provision a Basic IAM System User Suitable for CI/CD Systems (E.g. TravisCI, CircleCI)"
    url: "https://github.com/cloudposse/terraform-aws-iam-system-user"
  - 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-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-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-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"
  - name: "terraform-aws-ssm-parameter-store"
    description: "Terraform module to populate AWS Systems Manager (SSM) Parameter Store with values from Terraform. Works great with Chamber."
    url: "https://github.com/cloudposse/terraform-aws-ssm-parameter-store"
  - name: "terraform-aws-kms-key"
    description: "Terraform module to provision a KMS key with alias"
    url: "https://github.com/cloudposse/terraform-aws-kms-key"
  - name: "terraform-aws-ssm-parameter-store-policy-documents"
    description: "A Terraform module that generates JSON documents for access for common AWS SSM Parameter Store policies"
    url: "https://github.com/cloudposse/terraform-aws-ssm-parameter-store-policy-documents"

# Short description of this project
description: |-
  Terraform module to provision a basic IAM [chamber](https://github.com/segmentio/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](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).

  We do not recommend creating IAM users this way for any other purpose.


# How to use this project
usage: |-
  ```hcl
  module "chamber_user" {
    source      = "git::https://github.com/cloudposse/terraform-aws-iam-chamber-user.git?ref=master"
    namespace   = "cp"
    stage       = "prod"
    name        = "chamber"
    kms_key_arn = "arn:aws:kms:us-west-2:253234095951:key/abfd558e-3275-4ece-84e5-b35abc46c243"
  }
  ```
include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:  
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Igor Rodionov"
    github: "goruha"
  - name: "Sarkis Varozian"
    github: "sarkis"