Module: `iam-user`

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.

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 = "cloudposse/iam-user/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  name       = "jack"
  user_name  = "[email protected]"
  pgp_key    = "keybase:jack"
  groups     = ["admins"]
}

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

Examples

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  = "[email protected]"
  pgp_key    = "keybase:jill"
  groups    = ["engineering"]
}

Variables

Required Variables

pgp_key (string) required: Provide a base-64 encoded PGP public key, or a keybase username in the form keybase:username. Required to encrypt password.
user_name (string) required: Desired name for the IAM user. We recommend using email addresses.

Optional Variables

force_destroy (bool) optional

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.

Default value: false

groups (list(string)) optional

List of IAM user groups this user should belong to in the account

Default value: [ ]

login_profile_enabled (bool) optional

Whether to create IAM user login profile

Default value: true

password_length (number) optional

The length of the generated password

Default value: 24

password_reset_required (bool) optional

Whether the user should be forced to reset the generated password on first login.

Default value: true

path (string) optional

Desired path for the IAM user

Default value: "/"

permissions_boundary (string) optional

The ARN of the policy that is used to set the permissions boundary for the user

Default value: ""

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

keybase_password_decrypt_command: Command to decrypt the Keybase encrypted password. Returns empty string if pgp_key is not from keybase
keybase_password_pgp_message: PGP encrypted message (e.g. suitable for email exchanges). Returns empty string if pgp_key is not from keybase
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

Dependencies

Requirements

terraform, version: >= 0.13.0
aws, version: >= 2.0
null, version: >= 2.0

Providers

aws, version: >= 2.0

Modules

Name	Version	Source	Description
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_iam_user.default (resource)
aws_iam_user_group_membership.default (resource)
aws_iam_user_login_profile.default (resource)

Data Sources

The following data sources are used by this module:

Module: iam-user

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `iam-user`

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources