Terraform Module to provision a basic IAM user suitable for humans.
Switch branches/tags
Nothing to show
Clone or download
osterman fix destroy (#2)
* fix destroy

* format
Latest commit 8b2f417 Oct 25, 2018

README.md

Cloud Posse

terraform-aws-iam-user Build Status Latest Release Slack Community

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 module.


This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Usage

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

module "jack" {
  source     = "git::https://github.com/cloudposse/terraform-aws-iam-user.git?ref=master"
  name       = "jack"
  pgp_key    = "keybase:jack"
  groups     = ["admins"]
}

NOTE: We recommend using email addresses for IAM user accounts.

Examples

module "jill" {
  source    = "git::https://github.com/cloudposse/terraform-aws-iam-user.git?ref=master"
  name      = "jill"
  pgp_key    = "keybase:jill"
  groups    = ["engineering"]
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name Description Type Default Required
enabled Whether to create the IAM user string true no
force_destroy When destroying this user, destroy even if it has non-Terraform-managed IAM access keys, login profile or MFA devices. Without force_destroy a user with non-Terraform-managed access keys and login profile will fail to be destroyed. string false no
groups List of IAM user groups this user should belong to in the account list <list> no
login_profile_enabled Whether to create IAM user login profile string true no
name Desired name for the IAM user. We recommend using email addresses. string - yes
password_length The length of the generated password string 24 no
password_reset_required Whether the user should be forced to reset the generated password on first login. string true no
path Desired path for the IAM user string / no
permissions_boundary The ARN of the policy that is used to set the permissions boundary for the user string `` no
pgp_key Provide a base-64 encoded PGP public key, or a keybase username in the form keybase:username. Required to encrypt password. string - yes

Outputs

Name Description
keybase_password_decrypt_command Command to decrypt the Keybase encrypted password
keybase_password_pgp_message PGP encrypted message (e.g. suitable for email exchanges)
pgp_key PGP key used to encrypt sensitive data for this user
user_arn The ARN assigned by AWS for this user
user_login_profile_encrypted_password The encrypted password, base64 encoded
user_login_profile_key_fingerprint The fingerprint of the PGP key used to encrypt the password
user_name IAM user name
user_unique_id The unique ID assigned by AWS

Related Projects

Check out these related projects.

  • terraform-aws-iam-assumed-roles - Terraform Module for Assumed Roles on AWS with IAM Groups Requiring MFA
  • terraform-aws-iam-s3-user - 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
  • terraform-aws-organization-access-group - 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
  • terraform-aws-ssm-iam-role - Terraform module to provision an IAM role with configurable permissions to access SSM Parameter Store
  • terraform-aws-iam-chamber-user - 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
  • terraform-aws-lb-s3-bucket - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

E-Mail

  • Questions. We'll use a Shared Slack channel between your team and ours.
  • Troubleshooting. We'll help you triage why things aren't working.
  • Code Reviews. We'll review your Pull Requests and provide constructive feedback.
  • Bug Fixes. We'll rapidly work to fix any bugs in our projects.
  • Build New Terraform Modules. We'll develop original modules to provision infrastructure.
  • Cloud Architecture. We'll assist with your cloud strategy and design.
  • Implementation. We'll provide hands-on support to implement our reference architectures.

Community Forum

Get access to our Open Source Community Forum on Slack. It's FREE to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build sweet infrastructure.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2018 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at hello@cloudposse.com

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We love Open Source Software!

We offer paid support on all of our projects.

Check out our other projects, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman
Erik Osterman
Igor Rodionov
Igor Rodionov
Andriy Knysh
Andriy Knysh