/terraform-aws-iam-user

Terraform module to create Iam user resource on AWS.

Primary LanguageHCLApache License 2.0Apache-2.0

Terraform AWS Iam User

Terraform module to create Iam user resource on AWS.

Terraform Licence tfsec static-checks


We eat, drink, sleep and most importantly love DevOps. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure.

This module is basically combination of Terraform open source and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.

We have fifty plus terraform modules. A few of them are comepleted and are available for open source usage while a few others are in progress.

Prerequisites

This module has a few dependencies:

Examples

IMPORTANT: Since the master branch used in source varies based on new modifications, we suggest that you use the release versions here.

Simple example

Here is an example of how you can use this module in your inventory structure:

  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 = ["*"]
    }
  }

Inputs

Name Description Type Default Required
attributes Additional attributes (e.g. 1). list(any) [] no
create_iam_user_login_profile Whether to create IAM user login profile bool true no
create_user Whether to create the IAM user bool true no
delimiter Delimiter to be used between organization, environment, name and attributes. string "-" no
enabled Whether to create Iam user. bool true no
environment Environment (e.g. prod, dev, staging). string "" 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. bool false no
groups (Optional) List of IAM groups to add the User to. list(string) [] no
label_order Label order, e.g. name,application. list(any) [] no
managedby ManagedBy, eg 'CloudDrove' string "hello@clouddrove.com" no
name Name (e.g. app or cluster). string "" no
password_length The length of the generated password number 20 no
password_reset_required Whether the user should be forced to reset the generated password on first login. bool true no
path The path to the role. string "/" no
permissions_boundary The ARN of the policy that is used to set the permissions boundary for the role. string "" no
pgp_key Either a base-64 encoded PGP public key, or a keybase username in the form keybase:some_person_that_exists. string "" no
policy The policy document. any null no
policy_arn The ARN of the policy you want to apply. string "" no
policy_enabled Whether to Attach Iam policy with user. bool false no
repository Terraform current module repo string "https://github.com/clouddrove/terraform-aws-iam-user" no
ssh_key_encoding Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM string "SSH" no
ssh_public_key The SSH public key. The public key must be encoded in ssh-rsa format or PEM format string "" no
status The access key status to apply. Defaults to Active. Valid values are Active and Inactive. string "Active" no
tags Additional tags (e.g. map(BusinessUnit,XYZ). map(any) {} no
upload_iam_user_ssh_key Whether to upload a public ssh key to the IAM user bool false no

Outputs

Name Description
arn The ARN assigned by AWS for this user.
key_id The access key ID.
secret The secret access key. Note that this will be written to the state file. Please supply a pgp_key instead, which will prevent the secret from being stored in plain text.
tags A mapping of tags to assign to the resource.
unique_id The unique ID assigned by AWS for this user.

Testing

In this module testing is performed with terratest and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a GO environment in your system.

You need to run the following command in the testing folder:

  go test -run Test

Feedback

If you come accross a bug or have any feedback, please log it in our issue tracker, or feel free to drop us an email at hello@clouddrove.com.

If you have found it worth your time, go ahead and give us a ★ on our GitHub!

About us

At CloudDrove, we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering.

We are The Cloud Experts!


We ❤️ Open Source and you can check out our other modules to get help with your new Cloud ideas.