https://github.com/cloudposse/terraform-aws-ssm-iam-role

Terraform module to provision an IAM role with configurable permissions to access SSM Parameter Store
https://github.com/cloudposse/terraform-aws-ssm-iam-role
aws chamber iam kiam kms kube2iam kubernetes parameter-store permissions role secrets ssm terraform terraform-module
Last synced: 5 months ago
JSON representation
Terraform module to provision an IAM role with configurable permissions to access SSM Parameter Store
Host: GitHub
URL: https://github.com/cloudposse/terraform-aws-ssm-iam-role
Owner: cloudposse
License: apache-2.0
Created: 2018-06-13T19:06:57.000Z (almost 7 years ago)
Default Branch: main
Last Pushed: 2024-09-06T16:27:25.000Z (8 months ago)
Last Synced: 2024-09-06T19:41:14.220Z (8 months ago)
Topics: aws, chamber, iam, kiam, kms, kube2iam, kubernetes, parameter-store, permissions, role, secrets, ssm, terraform, terraform-module
Language: HCL
Homepage: https://cloudposse.com/accelerate
Size: 2.01 MB
Stars: 21
Watchers: 17
Forks: 15
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project

README

        




    




Terraform module to provision an IAM role with configurable permissions to access [SSM Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html).

> [!TIP]

> #### 👽 Use Atmos with Terraform

> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. 


> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).

>

> 

> Watch demo of using Atmos with Terraform

> 


> Example of running atmos to manage infrastructure from our Quick Start tutorial.

> 

## Introduction

For more information on how to control access to Systems Manager parameters by using AWS Identity and Access Management, see [Controlling Access to Systems Manager Parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-access.html).

For more information on how to use parameter hierarchies to help organize and manage parameters, see [Organizing Parameters into Hierarchies](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-organize.html).

__NOTE:__ This module can be used to provision IAM roles with SSM permissions for [chamber](https://docs.cloudposse.com/tools/chamber/).  

## Usage

This example creates a role with the name `cp-prod-app-all` with permission to read all SSM parameters, 

and gives permission to the entities specified in `assume_role_arns` to assume the role.

```hcl

module "ssm_iam_role" {

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

  namespace        = "cp"

  stage            = "prod"

  name             = "app"

  attributes       = ["all"]

  region           = "us-west-2"

  account_id       = "XXXXXXXXXXX"

  assume_role_arns = ["arn:aws:xxxxxxxxxx", "arn:aws:yyyyyyyyyyyy"]

  kms_key_arn      = "arn:aws:kms:us-west-2:123454095951:key/aced568e-3375-4ece-85e5-b35abc46c243"

  ssm_parameters   = ["*"]

  ssm_actions      = ["ssm:GetParametersByPath", "ssm:GetParameters"]

}

```

> [!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.

## Examples

### Example With Permission For Specific Resources

This example creates a role with the name `cp-prod-app-secrets` with permission to read the SSM parameters that begin with `secret-`, 

and gives permission to the entities specified in `assume_role_arns` to assume the role.

```hcl

module "ssm_iam_role" {

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

  namespace        = "cp"

  stage            = "prod"

  name             = "app"

  attributes       = ["secrets"]

  region           = "us-west-2"

  account_id       = "XXXXXXXXXXX"

  assume_role_arns = ["arn:aws:xxxxxxxxxx", "arn:aws:yyyyyyyyyyyy"]

  kms_key_arn      = "arn:aws:kms:us-west-2:123454095951:key/aced568e-3375-4ece-85e5-b35abc46c243"

  ssm_parameters   = ["secret-*"]

  ssm_actions      = ["ssm:GetParameters"]

}

```

### Complete Example

This example:

* Provisions a KMS key to encrypt SSM Parameter Store secrets using [terraform-aws-kms-key](https://github.com/cloudposse/terraform-aws-kms-key) module

* Performs `Kops` cluster lookup to find the ARNs of `masters` and `nodes` by using [terraform-aws-kops-metadata](https://github.com/cloudposse/terraform-aws-kops-metadata) module

* Creates a role with the name `cp-prod-chamber-kops` with permission to read all SSM parameters from the path `kops`, 

and gives permission to the Kops `masters` and `nodes` to assume the role

```hcl

module "kms_key" {

  source      = "git::https://github.com/cloudposse/terraform-aws-kms-key.git?ref=master"

  namespace   = "cp"

  stage       = "prod"

  name        = "chamber"

  description = "KMS key for SSM"

}

module "kops_metadata" {

  source       = "git::https://github.com/cloudposse/terraform-aws-kops-metadata.git?ref=master"

  dns_zone     = "us-west-2.prod.cloudposse.co"

  masters_name = "masters"

  nodes_name   = "nodes"

}

module "ssm_iam_role" {

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

  namespace        = "cp"

  stage            = "prod"

  name             = "chamber"

  attributes       = ["kops"]

  region           = "us-west-2"

  account_id       = "XXXXXXXXXXX"

  assume_role_arns = ["${module.kops_metadata.masters_role_arn}", "${module.kops_metadata.nodes_role_arn}"]

  kms_key_arn      = "${module.kms_key.key_arn}"

  ssm_parameters   = ["kops/*"]

  ssm_actions      = ["ssm:GetParametersByPath", "ssm:GetParameters"]

}

```

> [!TIP]

> #### Use Terraform Reference Architectures for AWS

>

> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) 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.


>

> 

> 📚 Learn More

>

> 


>

> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-iam-role&utm_content=commercial_support) 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.

>

> 

>

> #### 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.

>

> 

> 

## Makefile Targets

```text

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](#provider\_aws) | n/a |

## Modules

| Name | Source | Version |

|------|--------|---------|

|  [label](#module\_label) | git::https://github.com/cloudposse/terraform-terraform-label.git | 0.1.3 |

## Resources

| Name | Type |

|------|------|

| [aws_iam_policy.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |

| [aws_iam_role.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |

| [aws_iam_role_policy_attachment.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |

| [aws_iam_policy_document.assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |

| [aws_iam_policy_document.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |

| [aws_kms_key.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/kms_key) | data source |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [account\_id](#input\_account\_id) | AWS account ID | `string` | n/a | yes |

|  [assume\_role\_arns](#input\_assume\_role\_arns) | List of ARNs to allow assuming the role. Could be AWS services or accounts, Kops nodes, IAM users or groups | `list(string)` | n/a | yes |

|  [attributes](#input\_attributes) | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no |

|  [delimiter](#input\_delimiter) | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | `string` | `"-"` | no |

|  [kms\_key\_reference](#input\_kms\_key\_reference) | The Key ID, Key ARN, Key Alias Name, or Key Alias ARN of the KMS key which will encrypt/decrypt SSM secret strings | `any` | n/a | yes |

|  [max\_session\_duration](#input\_max\_session\_duration) | The maximum session duration (in seconds) for the role. Can have a value from 1 hour to 12 hours | `number` | `3600` | no |

|  [name](#input\_name) | Name (e.g. `app` or `chamber`) | `string` | n/a | yes |

|  [namespace](#input\_namespace) | Namespace (e.g. `cp` or `cloudposse`) | `string` | n/a | yes |

|  [region](#input\_region) | AWS Region | `string` | n/a | yes |

|  [ssm\_actions](#input\_ssm\_actions) | SSM actions to allow | `list(string)` | 
[
  "ssm:GetParametersByPath",
  "ssm:GetParameters"
] | no |

|  [ssm\_parameters](#input\_ssm\_parameters) | List of SSM parameters to apply the actions. A parameter can include a path and a name pattern that you define by using forward slashes, e.g. `kops/secret-*` | `list(string)` | n/a | yes |

|  [stage](#input\_stage) | Stage (e.g. `prod`, `dev`, `staging`) | `string` | n/a | yes |

|  [tags](#input\_tags) | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | `map(string)` | `{}` | no |

## Outputs

| Name | Description |

|------|-------------|

|  [role\_arn](#output\_role\_arn) | The Amazon Resource Name (ARN) specifying the role |

|  [role\_id](#output\_role\_id) | The stable and unique string identifying the role |

|  [role\_name](#output\_role\_name) | The name of the crated role |

|  [role\_policy\_document](#output\_role\_policy\_document) | A copy of the IAM policy document (JSON) that grants permissions to this role. |

## Related Projects

Check out these related projects.

- [terraform-aws-ssm-parameter-store](https://github.com/cloudposse/terraform-aws-ssm-parameter-store) - Terraform module to populate AWS Systems Manager (SSM) Parameter Store with values from Terraform. Works great with Chamber.

- [terraform-aws-ssm-parameter-store-policy-documents](https://github.com/cloudposse/terraform-aws-ssm-parameter-store-policy-documents) - A Terraform module that generates JSON documents for access for common AWS SSM Parameter Store policies

- [terraform-aws-iam-chamber-user](https://github.com/cloudposse/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

## ✨ 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](https://github.com/cloudposse/terraform-aws-ssm-iam-role/issues).

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

 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-ssm-iam-role/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).

 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](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-iam-role&utm_content=slack) 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](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-iam-role&utm_content=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](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ssm-iam-role&utm_content=office_hours) 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



Preamble to the Apache License, Version 2.0







Complete license is available in the [`LICENSE`](LICENSE) file.

```text

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](https://cpco.io/copyright)
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/cloudposse/terraform-aws-ssm-iam-role

Awesome Lists containing this project

README
