terraform-aws-iam-role

A Terraform module that creates IAM role with provided JSON IAM polices documents.

Warning

If var.enabled set false the module can be used as IAM Policy Document Aggregator because output.policy always aggregates var.policy_documents
List size var.policy_documents limited to 10

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

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

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

This example creates a role with the name cp-prod-app with permission to grant read-write access to S3 bucket, and gives permission to the entities specified in principals_arns to assume the role.

  data "aws_iam_policy_document" "resource_full_access" {
    statement {
      sid       = "FullAccess"
      effect    = "Allow"
      resources = ["arn:aws:s3:::bucketname/path/*"]

      actions = [
        "s3:PutObject",
        "s3:PutObjectAcl",
        "s3:GetObject",
        "s3:DeleteObject",
        "s3:ListBucket",
        "s3:ListBucketMultipartUploads",
        "s3:GetBucketLocation",
        "s3:AbortMultipartUpload",
      ]
    }
  }

  data "aws_iam_policy_document" "base" {
    statement {
      sid = "BaseAccess"

      actions = [
        "s3:ListBucket",
        "s3:ListBucketVersions",
      ]

      resources = ["arn:aws:s3:::bucketname"]
      effect    = "Allow"
    }
  }

  module "role" {
    source     = "git::https://github.com/cloudposse/terraform-aws-iam-role.git?ref=master"

    enabled    = "true"
    namespace = "cp"
    stage     = "prod"
    name      = "app"

    policy_description = "Allow S3 FullAccess"
    role_description   = "IAM role with permissions to perform actions on S3 resources"

    principals_arns = ["arn:aws:iam::123456789012:role/workers"]
    policy_documents = [
      "${data.aws_iam_policy_document.resource_full_access.json}",
      "${data.aws_iam_policy_document.base.json}",
    ]
  }

Additional Examples

The example directory contains complete working examples with variations of how to use the module.

Inputs

Name	Description	Type	Default	Required
attributes	Additional attributes (e.g. `1`)	list	`<list>`	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
max_session_duration	The maximum session duration (in seconds) for the role. Can have a value from 1 hour to 12 hours	string	`3600`	no
name	Name (e.g. `app` or `chamber`)	string	-	yes
namespace	Namespace (e.g. `cp` or `cloudposse`)	string	-	yes
policy_description	The description of the IAM policy that is visible in the IAM policy manager	string	-	yes
policy_documents	List of JSON IAM policy documents	list	`<list>`	no
principals_arns	List of ARNs to allow assuming the role. Could be AWS accounts, Kops nodes, IAM users or groups	list	-	yes
principals_services_arns	List of Services identifiers to allow assuming the role.	list	`<list>`	no
role_description	The description of the IAM role that is visible in the IAM role manager	string	-	yes
stage	Stage (e.g. `prod`, `dev`, `staging`)	string	-	yes
tags	Additional tags (e.g. map(`BusinessUnit`,`XYZ`)	map	`<map>`	no

Outputs

Name	Description
arn	The Amazon Resource Name (ARN) specifying the role
id	The stable and unique string identifying the role
name	The name of the IAM role created
policy	Role policy document in json format. Outputs always, independent of `enabled` variable

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-aws-iam-policy-document-aggregator - Terraform module to aggregate multiple IAM policy documents into single policy document
terraform-aws-iam-chamber-s3-role - Terraform module to provision an IAM role with configurable permissions to access S3 as chamber backend

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.

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.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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.

Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

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.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
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

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 by leaving a testimonial!

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

We offer paid support on all of our projects.

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

Contributors

Igor Rodionov	Oscar Sullivan

rverma-nikiai / terraform-aws-iam-role

terraform-aws-iam-role

Warning

Usage

Additional Examples

Inputs

Outputs

Share the Love

Related Projects

Help

Commercial Support

Terraform Module Development

Slack Community

Newsletter

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors

About

Languages