This component is responsible for provisioning user and system IAM roles outside the
It sets them up to be assumed from the "team" roles defined in the
identity account by
aws-teams component and/or the AWS SSO permission sets
defined in the
Stack Level: Global
Deployment: Must be deployed by SuperAdmin using
Here's an example snippet for how to use this component. This specific usage is an example only, and not intended for production use.
You set the defaults in one YAML file, and import that file into each account's Global stack (except for the
identity account itself).
If desired, you can make account-specific changes by overriding settings, for example
- Disable entire roles in the account by setting
- Limit who can access the role by setting a different value for
- Change the permissions available to that role by overriding the
role_policy_arns(not recommended, limit access to the role or create a different role with the desired set of permissions instead).
Note that when overriding, maps are deep merged, but lists are replaced. This means, for example, that your setting of
trusted_primary_roles in an override completely replaces the default, it does not add to it, so if you want to allow an extra "primary" role to have access to the role, you have to include all the default "primary" roles in the list, too, or they will lose access.
# Override the default Role for accessing the backend, because SuperAdmin is not allowed to assume that role
# `template` serves as the default configuration for other roles via the YAML anchor.
# However, `atmos` does not support "import" of YAML anchors, so if you define a new role
# in another file, you will not be able to reference this anchor.
# If `enabled: false`, the role will not be created in this account
# `max_session_duration` set the maximum session duration (in seconds) for the IAM roles.
# This setting can have a value from 3600 (1 hour) to 43200 (12 hours).
# For roles people log into via SAML, a long duration is convenient to prevent them
# from having to frequently re-authenticate.
# For roles assumed from some other role, the setting is practically irrelevant, because
# the AssumeRole API limits the duration to 1 hour in any case.
# - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
# - https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
max_session_duration: 3600 # 1 hour in seconds
# role_policy_arns are the IAM Policy ARNs to attach to this policy. In addition to real ARNs,
# you can use keys in the `custom_policy_map` in `main.tf` to select policies defined in the component.
# If you are using keys from the map, plans look better if you put them after the real role ARNs.
role_description: "Template role, should not exist"
# If `aws_saml_login_enabled: true` then the role will be available via SAML logins,
# but only via the SAML IDPs configured for this account.
# Otherwise, it will only be accessible via `assume role`.
## The following attributes control access to this role via `assume role`.
## `trusted_*` grants access, `denied_*` denies access.
## If a role is both trusted and denied, it will not be able to access this role.
# Permission sets specify users operating from the given AWS SSO permission set in this account.
# Primary roles specify the short role names of roles in the primary (identity)
# account that are allowed to assume this role.
# BE CAREFUL: This is setting the default access for other roles.
# Role ARNs specify Role ARNs in any account that are allowed to assume this role.
# BE CAREFUL: there is nothing limiting these Role ARNs to roles within our organization.
## admin and terraform are the core team roles
role_description: "Full administration of this account"
# We require Terraform to be allowed to create and modify IAM roles
# and policies (e.g. for EKS service accounts), so there is no use trying to restrict it.
# For better security, we could segregate components that needed
# administrative permissions and use a more restrictive role
# for Terraform, such as PowerUser (further restricted to deny AWS SSO changes).
role_description: "Role for Terraform administration of this account"
trusted_teams: ["admin", "spacelift"]
|additional_tag_map||Additional key-value pairs to add to each map in |
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.
|attributes||ID element. Additional attributes (e.g. |
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 the
and treated as a single ID element.
|context||Single object for setting entire context at once.|
See description of individual variables for details.
Leave string and numeric variables as
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
|delimiter||Delimiter to be used between ID elements.|
|descriptor_formats||Describe additional descriptors to be output in the |
Map of maps. Keys are names of descriptors. Values are maps of the form
Label values will be normalized before being passed to
identical to how they appear in
|enabled||Set to false to prevent the module from creating any resources||no|
|environment||ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'||no|
Does not affect
|import_role_arn||IAM Role ARN to use when importing a resource||no|
|label_key_case||Controls the letter case of the |
Does not affect keys of tags passed in via the
|label_order||The order in which the labels (ID elements) appear in the |
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.
|label_value_case||Controls the letter case of ID elements (labels) as included in |
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the
Set this to
|labels_as_tags||Set of labels (ID elements) to include as tags in the |
Default is to include all labels.
Tags with empty values will not be included in the
The value of the
changed in later chained modules. Attempts to change it will be silently ignored.
|name||ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.|
This is the only ID element not also included as a
The "name" tag is set to the full
|namespace||ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique||no|
|regex_replace_chars||Terraform regular expression (regex) string.|
Characters matching the regex will be removed from the ID elements.
If not set,
|roles||A map of roles to configure the accounts.||n/a||yes|
|stage||ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'||no|
|tags||Additional tags (e.g. |
Neither the tag keys nor the tag values will be modified by this module.
|tenant||ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for||no|
|trusted_github_repos||Map where keys are role names (same keys as |
GitHub repositories allowed to assume those roles. See
for specifics about repository designations.
|role_name_role_arn_map||Map of role names to role ARNs|
- cloudposse/terraform-aws-components - Cloud Posse's upstream components