Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Terraform Module to Provision a Basic IAM System User Suitable for CI/CD Systems (E.g. TravisCI, CircleCI)

License

NotificationsYou must be signed in to change notification settings

cloudposse/terraform-aws-iam-system-user

Project Banner

Latest ReleaseLast UpdatedSlack CommunityGet Support

Terraform Module to provision a basic IAM system user suitable for CI/CD Systems(e.g. TravisCI, CircleCI) or systems which areexternal to AWS that cannot leverageAWS IAM Instance ProfilesorAWS OIDC.

We do not recommend creating IAM users this way for any other purpose.

By default, IAM users, groups, and roles have no access to AWS resources. IAM policies are the means by which privileges are granted to users, groups, or roles. It is recommended that IAM policies be applied directly to groups and roles but not users.This module intentionally attaches an IAM policy directly to the user and does not use groups

The IAM user name is constructed usingterraform-null-labeland some input is required. The simplest input isname. By default the name will be converted to lower caseand all non-alphanumeric characters except for hyphen will be removed. See the documentation forterraform-null-labelto learn how to override these defaults if desired.

If an AWS Access Key is created, it is stored either in SSM Parameter Store or is provided as a module output,but not both. Using SSM Parameter Store is recommended because module outputs are stored in plaintext inthe Terraform state file.

Tip

👽 Use Atmos with Terraform

Cloud Posse usesatmos to easily orchestrate multiple environments using Terraform.
Works withGithub Actions,Atlantis, orSpacelift.

Watch demo of using Atmos with Terraform
Example of runningatmos to manage infrastructure from ourQuick Start tutorial.

Usage

module"circleci" {source="cloudposse/iam-system-user/aws"# Cloud Posse recommends pinning every module to a specific version# version     = "x.x.x"namespace="eg"stage="circleci"name="assets"}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentationand the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact versionyou're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematicapproach for updating versions to avoid unexpected changes.

Examples

module"fluentd_user" {source="cloudposse/iam-system-user/aws"# Cloud Posse recommends pinning every module to a specific version# version     = "x.x.x"namespace="eg"stage="dev"name="fluentd"policy_arns_map={    logs="arn:aws:iam::aws:policy/CloudWatchLogsFullAccess"  }inline_policies_map={    s3= data.aws_iam_policy_document.s3_policy.json  }}data"aws_iam_policy_document""s3_policy" {statement {actions=["s3:PutObject","s3:GetObjectAcl","s3:GetObject","s3:ListBucket","s3:PutObjectAcl"    ]resources=["arn:aws:s3:::bucket_name/*","arn:aws:s3:::bucket_name/"    ]  }}

Requirements

NameVersion
terraform>= 0.13.0
aws>= 2.0

Providers

NameVersion
aws>= 2.0

Modules

NameSourceVersion
store_writecloudposse/ssm-parameter-store/aws0.13.0
thiscloudposse/label/null0.25.0

Resources

NameType
aws_iam_access_key.defaultresource
aws_iam_user.defaultresource
aws_iam_user_policy.inline_policiesresource
aws_iam_user_policy_attachment.policiesresource

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional key-value pairs to add to each map intags_as_list_of_maps. Not added totags orid.
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.
map(string){}no
attributesID element. Additional attributes (e.g.workers orcluster) to add toid,
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 thedelimiter
and treated as a single ID element.
list(string)[]no
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables asnull 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.
any
{
"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
}
no
create_iam_access_keyWhether or not to create IAM access keysbooltrueno
delimiterDelimiter to be used between ID elements.
Defaults to- (hyphen). Set to"" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe additional descriptors to be output in thedescriptors 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 isany so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to theformat() function.
labels is a list of labels, in order, to pass toformat() function.
Label values will be normalized before being passed toformat() so they will be
identical to how they appear inid.
Default is{} (descriptors output will be empty).
any{}no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
force_destroyDestroy the user even if it has non-Terraform-managed IAM access keys, login profile or MFA devicesboolfalseno
id_length_limitLimitid to this many characters (minimum 6).
Set to0 for unlimited length.
Set tonull for keep the existing setting, which defaults to0.
Does not affectid_full.
numbernullno
inline_policiesInline policies to attach to our created userlist(string)[]no
inline_policies_mapInline policies to attach (descriptive key => policy)map(string){}no
label_key_caseControls the letter case of thetags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via thetags input.
Possible values:lower,title,upper.
Default value:title.
stringnullno
label_orderThe order in which the labels (ID elements) appear in theid.
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.
list(string)nullno
label_value_caseControls the letter case of ID elements (labels) as included inid,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via thetags input.
Possible values:lower,title,upper andnone (no transformation).
Set this totitle and setdelimiter to"" to yield Pascal Case IDs.
Default value:lower.
stringnullno
labels_as_tagsSet of labels (ID elements) to include as tags in thetags output.
Default is to include all labels.
Tags with empty values will not be included in thetags output.
Set to[] to suppress all generated tags.
Notes:
The value of thename tag, if included, will be theid, not thename.
Unlike othernull-label inputs, the initial setting oflabels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as atag.
The "name" tag is set to the fullid string. There is no tag with the value of thename input.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
pathPath in which to create the userstring"/"no
permissions_boundaryPermissions Boundary ARN to attach to our created userstringnullno
policy_arnsPolicy ARNs to attach to our created userlist(string)[]no
policy_arns_mapPolicy ARNs to attach (descriptive key => arn)map(string){}no
regex_replace_charsTerraform 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.
stringnullno
ssm_base_pathThe base path for SSM parameters where secrets are storedstring"/system_user/"no
ssm_enabledSettrue to store secrets in SSM Parameter Store,<br/>false to store secrets in Terraform state as outputs.
Since Terraform state would contain the secrets in plaintext,
use of SSM Parameter Store is recommended.
booltrueno
ssm_ses_smtp_password_enabledWhether or not to create an SES SMTP passwordboolfalseno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g.{'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
access_key_idThe access key ID
access_key_id_ssm_pathThe SSM Path under which the IAM User's access key ID is stored
secret_access_keyWhenssm_enabled isfalse, this is the secret access key for the IAM user.
This will be written to the state file in plain-text.
Whenssm_enabled istrue, this output will be empty to keep the value secure.
secret_access_key_ssm_pathThe SSM Path under which the IAM User's secret access key is stored
ses_smtp_password_v4Whenssm_enabled is false, this is the secret access key converted into an SES SMTP password
by applying AWS's Sigv4 conversion algorithm. It will be written to the Terraform state file in plaintext.
Whenssm_enabled istrue, this output will be empty to keep the value secure.
ses_smtp_password_v4_ssm_pathThe SSM Path under which the IAM User's SES SMTP password is stored
ssm_enabledtrue when secrets are stored in SSM Parameter store,
false when secrets are stored in Terraform state as outputs.
user_arnThe ARN assigned by AWS for this user
user_nameNormalized IAM user name
user_unique_idThe unique ID assigned by AWS

Related Projects

Check out these related projects.

  • 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-iam-assumed-roles - Terraform Module for Assumed Roles on AWS with IAM Groups Requiring MFA
  • terraform-aws-ssm-iam-role - Terraform module to provision an IAM role with configurable permissions to access SSM Parameter Store
  • 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-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-null-label - Terraform Module to implement a consistent naming convention

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-goterraform 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 leadingDevOps 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 theissue tracker.

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

  1. Review ourCode of Conduct andContributor 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 aPull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We useAtmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in thetest/ folder.

Under the hood, tests are powered by Terratest together with our internalTest Helpers library, providing robust infrastructure validation.

Setup dependencies:

To run tests:

  • Run all tests:
    atmostest run
  • Clean up test artifacts:
    atmostest clean
  • Explore additional test options:
    atmostest --help

The configuration for test commands is centrally managed. To review what's being imported, see theatmos.yaml file.

Learn more about ourautomated testing in our documentation or implementingcustom commands with atmos.

🌎 Slack Community

Join ourOpen Source Community on Slack. It'sFREE 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 totallysweet infrastructure.

📰 Newsletter

Sign up forour 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 alive Q&A that you can’t find anywhere else.It'sFREE for everyone!

License

License

Preamble to the Apache License, Version 2.0

Complete license is available in theLICENSE file.

Licensed to the Apache Software Foundation (ASF) under oneor more contributor license agreements.  See the NOTICE filedistributed with this work for additional informationregarding copyright ownership.  The ASF licenses this fileto you under the Apache License, Version 2.0 (the"License"); you may not use this file except in compliancewith the License.  You may obtain a copy of the License at  https://www.apache.org/licenses/LICENSE-2.0Unless 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 ANYKIND, either express or implied.  See the License for thespecific language governing permissions and limitationsunder the License.

Trademarks

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


Copyright © 2017-2025Cloud Posse, LLC

README footer

Beacon

About

Terraform Module to Provision a Basic IAM System User Suitable for CI/CD Systems (E.g. TravisCI, CircleCI)

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

[8]ページ先頭

©2009-2025 Movatter.jp