Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-iam-assumed-roles/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse/terraform-aws-iam-assumed-roles/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-iam-assumed-roles.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-iam-assumed-roles/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-iam-assumed-roles.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

Terraform module to provision two IAM roles and two IAM groups for assuming the roles provided MFA is present, and add IAM users to the groups.

To give a user administrator's access, add the user to the admin group.

To give a user readonly access, add the user to the readonly group.

[!TIP]

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

Usage

module "assumed_roles" {
  source              = "git::https://github.com/cloudposse/terraform-aws-iam-assumed-roles.git?ref=master"
  namespace           = "cp"
  stage               = "prod"
  admin_name          = "admin"
  readonly_name       = "readonly"
  admin_user_names    = ["User1","User2"] # Add these IAM users to the admin group
  readonly_user_names = ["User3","User4"] # Add these IAM users to the readonly group
}

[!IMPORTANT] In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

<!-- markdownlint-disable -->

Makefile Targets

Available targets:

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

<!-- markdownlint-restore --> <!-- markdownlint-disable -->

Requirements

No requirements.

Providers

NameVersion
<a name="provider_aws"></a> awsn/a

Modules

NameSourceVersion
<a name="module_admin_label"></a> admin_labelgit::https://github.com/cloudposse/terraform-null-label.gittags/0.3.3
<a name="module_readonly_label"></a> readonly_labelgit::https://github.com/cloudposse/terraform-null-label.gittags/0.3.3

Resources

NameType
aws_iam_group.adminresource
aws_iam_group.readonlyresource
aws_iam_group_membership.adminresource
aws_iam_group_membership.readonlyresource
aws_iam_group_policy_attachment.allow_chage_password_adminresource
aws_iam_group_policy_attachment.allow_change_password_readonlyresource
aws_iam_group_policy_attachment.assume_role_adminresource
aws_iam_group_policy_attachment.assume_role_readonlyresource
aws_iam_group_policy_attachment.key_management_adminresource
aws_iam_group_policy_attachment.key_management_readonlyresource
aws_iam_group_policy_attachment.manage_mfa_adminresource
aws_iam_group_policy_attachment.manage_mfa_readonlyresource
aws_iam_policy.allow_change_password_adminresource
aws_iam_policy.allow_change_password_readonlyresource
aws_iam_policy.allow_key_management_adminresource
aws_iam_policy.allow_key_management_readonlyresource
aws_iam_policy.assume_role_adminresource
aws_iam_policy.assume_role_readonlyresource
aws_iam_policy.manage_mfa_adminresource
aws_iam_policy.manage_mfa_readonlyresource
aws_iam_role.adminresource
aws_iam_role.readonlyresource
aws_iam_role_policy_attachment.adminresource
aws_iam_role_policy_attachment.readonlyresource
aws_caller_identity.currentdata source
aws_iam_policy_document.allow_change_passworddata source
aws_iam_policy_document.allow_key_managementdata source
aws_iam_policy_document.assume_role_admindata source
aws_iam_policy_document.assume_role_readonlydata source
aws_iam_policy_document.manage_mfadata source
aws_iam_policy_document.role_trustdata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_admin_name"></a> admin_nameName for the admin group and role (e.g. admin)string"admin"no
<a name="input_admin_user_names"></a> admin_user_namesOptional list of IAM user names to add to the admin grouplist(string)[]no
<a name="input_attributes"></a> attributesAdditional attributes (e.g. policy or role)list(string)[]no
<a name="input_delimiter"></a> delimiterDelimiter to be used between namespace, stage, name, and attributesstring"-"no
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesstring"true"no
<a name="input_namespace"></a> namespaceNamespace (e.g. cp or cloudposse)stringn/ayes
<a name="input_readonly_name"></a> readonly_nameName for the readonly group and role (e.g. readonly)string"readonly"no
<a name="input_readonly_user_names"></a> readonly_user_namesOptional list of IAM user names to add to the readonly grouplist(string)[]no
<a name="input_stage"></a> stageStage (e.g. prod, dev, staging)stringn/ayes
<a name="input_switchrole_url"></a> switchrole_urlURL to the IAM console to switch to a rolestring"https://signin.aws.amazon.com/switchrole?account=%s&roleName=%s&displayName=%s"no
<a name="input_tags"></a> tagsAdditional tags (e.g. map(BusinessUnit,XYZ)map(string){}no

Outputs

NameDescription
<a name="output_group_admin_arn"></a> group_admin_arnAdmin group ARN
<a name="output_group_admin_id"></a> group_admin_idAdmin group ID
<a name="output_group_admin_name"></a> group_admin_nameAdmin group name
<a name="output_group_readonly_arn"></a> group_readonly_arnReadonly group ARN
<a name="output_group_readonly_id"></a> group_readonly_idReadonly group ID
<a name="output_group_readonly_name"></a> group_readonly_nameReadonly group name
<a name="output_role_admin_arn"></a> role_admin_arnAdmin role ARN
<a name="output_role_admin_name"></a> role_admin_nameAdmin role name
<a name="output_role_readonly_arn"></a> role_readonly_arnReadonly role ARN
<a name="output_role_readonly_name"></a> role_readonly_nameReadonly role name
<a name="output_switchrole_admin_url"></a> switchrole_admin_urlURL to the IAM console to switch to the admin role
<a name="output_switchrole_readonly_url"></a> switchrole_readonly_urlURL to the IAM console to switch to the readonly role
<!-- markdownlint-restore -->

Related Projects

Check out these related projects.

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-assumed-roles&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-assumed-roles&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-assumed-roles&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse/terraform-aws-iam-assumed-roles/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-iam-assumed-roles&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

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

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE 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 totally sweet infrastructure.

πŸ“° Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-assumed-roles&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>

Complete license is available in the LICENSE file.

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.
</details>

Trademarks

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


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-assumed-roles&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-iam-assumed-roles?pixel&cs=github&cm=readme&an=terraform-aws-iam-assumed-roles"/>