Skip to content

Latest commit

 

History

History
315 lines (235 loc) · 21.6 KB

README.md

File metadata and controls

315 lines (235 loc) · 21.6 KB
Raw

Project Banner

Latest ReleaseLast UpdatedSlack Community

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.

  • Role and group with Administrator (full) access to AWS resources
  • Role and group with Readonly access to AWS resources

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.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform
Example of running atmos to manage infrastructure from our Quick Start tutorial.

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.

Makefile Targets

Available targets:

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

Requirements

No requirements.

Providers

Name Version
aws n/a

Modules

Name Source Version
admin_label git::https://github.com/cloudposse/terraform-null-label.git tags/0.3.3
readonly_label git::https://github.com/cloudposse/terraform-null-label.git tags/0.3.3

Resources

Name Type
aws_iam_group.admin resource
aws_iam_group.readonly resource
aws_iam_group_membership.admin resource
aws_iam_group_membership.readonly resource
aws_iam_group_policy_attachment.allow_chage_password_admin resource
aws_iam_group_policy_attachment.allow_change_password_readonly resource
aws_iam_group_policy_attachment.assume_role_admin resource
aws_iam_group_policy_attachment.assume_role_readonly resource
aws_iam_group_policy_attachment.key_management_admin resource
aws_iam_group_policy_attachment.key_management_readonly resource
aws_iam_group_policy_attachment.manage_mfa_admin resource
aws_iam_group_policy_attachment.manage_mfa_readonly resource
aws_iam_policy.allow_change_password_admin resource
aws_iam_policy.allow_change_password_readonly resource
aws_iam_policy.allow_key_management_admin resource
aws_iam_policy.allow_key_management_readonly resource
aws_iam_policy.assume_role_admin resource
aws_iam_policy.assume_role_readonly resource
aws_iam_policy.manage_mfa_admin resource
aws_iam_policy.manage_mfa_readonly resource
aws_iam_role.admin resource
aws_iam_role.readonly resource
aws_iam_role_policy_attachment.admin resource
aws_iam_role_policy_attachment.readonly resource
aws_caller_identity.current data source
aws_iam_policy_document.allow_change_password data source
aws_iam_policy_document.allow_key_management data source
aws_iam_policy_document.assume_role_admin data source
aws_iam_policy_document.assume_role_readonly data source
aws_iam_policy_document.manage_mfa data source
aws_iam_policy_document.role_trust data source

Inputs

Name Description Type Default Required
admin_name Name for the admin group and role (e.g. admin) string "admin" no
admin_user_names Optional list of IAM user names to add to the admin group list(string) [] no
attributes Additional attributes (e.g. policy or role) list(string) [] no
delimiter Delimiter to be used between namespace, stage, name, and attributes string "-" no
enabled Set to false to prevent the module from creating any resources string "true" no
namespace Namespace (e.g. cp or cloudposse) string n/a yes
readonly_name Name for the readonly group and role (e.g. readonly) string "readonly" no
readonly_user_names Optional list of IAM user names to add to the readonly group list(string) [] no
stage Stage (e.g. prod, dev, staging) string n/a yes
switchrole_url URL to the IAM console to switch to a role string "https://signin.aws.amazon.com/switchrole?account=%s&roleName=%s&displayName=%s" no
tags Additional tags (e.g. map(BusinessUnit,XYZ) map(string) {} no

Outputs

Name Description
group_admin_arn Admin group ARN
group_admin_id Admin group ID
group_admin_name Admin group name
group_readonly_arn Readonly group ARN
group_readonly_id Readonly group ID
group_readonly_name Readonly group name
role_admin_arn Admin role ARN
role_admin_name Admin role name
role_readonly_arn Readonly role ARN
role_readonly_name Readonly role name
switchrole_admin_url URL to the IAM console to switch to the admin role
switchrole_readonly_url URL to the IAM console to switch to the readonly role

Related Projects

Check out these related projects.

  • terraform-aws-iam-system-user - Terraform Module to Provision a Basic IAM System User Suitable for CI/CD Systems (E.g. TravisCI, CircleCI)
  • 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-ssm-iam-role - Terraform module to provision an IAM role with configurable permissions to access SSM Parameter Store
  • 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-lb-s3-bucket - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs
  • 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

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.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

Request Quote

📚 Learn More

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

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
  • Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
  • Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
  • GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Request Quote

Day-2: Your Operational Mastery

  • Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
  • Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
  • Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
  • Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
  • Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
  • Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
  • Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

Request Quote

✨ Contributing

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

Many thanks to our outstanding contributors:

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

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

License

Preamble to the Apache License, Version 2.0

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.

Trademarks

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

Copyright © 2017-2024 Cloud Posse, LLC

README footer

Beacon