This component is responsible for provisioning all primary user and system roles into the centralized identity account.
This is expected to be used alongside the
aws-team-roles component to provide
fine-grained role delegation across the account hierarchy.
Teams Function Like Groups and are Implemented as Roles
The "teams" created in the
identity account by this module can be thought of as access control "groups":
a user who is allowed access one of these teams gets access to a set of roles (and corresponding permissions)
across a set of accounts. Generally, there is nothing else provisioned in the
so the teams have limited access to resources in the
identity account by design.
Teams are implemented as IAM Roles in each account. Access to the "teams" in the
account is controlled by the
aws-sso components. Access to the roles in all the
other accounts is controlled by the "assume role" policies of those roles, which allow the "team"
or AWS SSO Permission set to assume the role (or not).
Privileges are Defined for Each Role in Each Account by
Every account besides the
identity account has a set of IAM roles created by the
aws-team-roles component. In that component, the account's roles are assigned privileges,
and those privileges ultimately determine what a user can do in that account.
Access to the roles can be granted in a number of ways.
One way is by listing "teams" created by this component as "trusted" (
meaning that users who have access to the team role in the
identity account are
allowed (trusted) to assume the role configured in the target account.
Another is by listing an AWS SSO Permission Set in the account (
Role Access is Enabled by SAML and/or AWS SSO configuration
Users can again access to a role in the
identity account through either (or both) of 2 mechanisms:
- SAML access is globally configured via the
aws-samlcomponent, enabling an external SAML Identity Provider (IdP) to control access to roles in the
identityaccount. (SAML access can be separately configured for other accounts, see the
aws-team-rolescomponents for more on that.)
- Individual roles are enabled for SAML access by setting
aws_saml_login_enabled: truein the role configuration.
- Individual users are granted access to these roles by configuration in the SAML IdP.
AWS SSO Access
aws-sso component can create AWS Permission Sets that allow users to assume specific roles
identity account. See the
aws-sso component for details.
Stack Level: Global
Deployment: Must be deployed by SuperAdmin using
Here's an example snippet for how to use this component. The component should only be applied once,
which is typically done via the identity stack (e.g.
# Viewer has the same permissions as Observer but only in this account. It is not allowed access to other accounts.
# Viewer also serves as the default configuration for all roles via the YAML anchor.
# `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: 43200 # 12 hours 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: "Team restricted to viewing resources in the identity account"
# If `aws_saml_login_enabled: true` then the role will be available via SAML logins.
# 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.
trusted_permission_sets: [ ]
denied_permission_sets: [ ]
# Primary roles specify the short role names of roles in the primary (identity)
# account that are allowed to assume this role.
trusted_teams: [ ]
denied_teams: [ "viewer" ]
# 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.
trusted_role_arns: [ ]
denied_role_arns: [ ]
role_description: "Team with PowerUserAccess permissions in `identity` and AdministratorAccess to all other accounts except `root`"
# Limit `admin` to Power User to prevent accidentally destroying the admin role itself
# Use SuperAdmin to administer IAM access
role_policy_arns: [ "arn:aws:iam::aws:policy/PowerUserAccess" ]
# TODO Create a "security" team with AdministratorAccess to audit and security, remove "admin" write access to those accounts
# list of roles in primary that can assume into this role in delegated accounts
# primary admin can assume delegated admin
trusted_teams: [ "admin" ]
# GH runner should be moved to its own `ghrunner` role
trusted_permission_sets: [ "IdentityAdminTeamAccess" ]
role_description: Team for our privileged Spacelift server
|account_map_environment_name||The name of the environment where ||no|
|account_map_stage_name||The name of the stage where ||no|
|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.
|aws_saml_environment_name||The name of the environment where SSO is provisioned||no|
|aws_saml_stage_name||The name of the stage where SSO is provisioned||no|
|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,
|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.
|teams_config||A roles map to configure the accounts.||n/a||yes|
|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_arns||List of role ARNs|
|team_name_role_arn_map||Map of team names to role ARNs|
|team_names||List of team names|
|teams_config||Map of team config with name, target arn, and description|
assume role policy: LimitExceeded: Cannot exceed quota for ACLSizePerRole: 2048
aws-teams architecture, when enabling access to a role via lots of AWS SSO Profiles, can create large "assume role" policies, large enough to exceed the default quota of 2048 characters. If you run into this limitation, you will get an error like this:
Error: error updating IAM Role (acme-gbl-root-tfstate-backend-analytics-ro) assume role policy: LimitExceeded: Cannot exceed quota for ACLSizePerRole: 2048
This can happen in either/both the
root accounts (for Terraform state access). So far, we have always been able to resolve this by requesting a quota increase, which is automatically granted a few minutes after making the request. To request the quota increase:
Log in to the AWS Web console as admin in the affected account
Set your region to N. Virginia
Navigate to the Service Quotas page via the account dropdown menu
Click on AWS Services in the left sidebar
Search for "IAM" and select "AWS Identity and Access Management (IAM)". (If you don't find that option, make sure you have selected the
Find and select "Role trust policy length"
Request an increase to 4096 characters
Wait for the request to be approved, usually less than a few minutes
- cloudposse/terraform-aws-components- Cloud Posse's upstream component