Skip to main content

Component: iam-role

This component is responsible for provisioning simple IAM roles. If a more complicated IAM role and policy are desired then it is better to use a separate component specific to that role.


Stack Level: Global


# stacks/catalog/iam-role.yaml
type: abstract
component: iam-role
workspace_enabled: true
enabled: true

Use-case: An IAM role for AWS Workspaces Directory since this service does not have a service linked role.

# stacks/catalog/aws-workspaces/directory/iam-role.yaml
- catalog/iam-role

component: iam-role
- iam-role/defaults
name: workspaces_DefaultRole
# Added _ here to allow the _ character
regex_replace_chars: /[^a-zA-Z0-9-_]/
# Keep the current name casing
label_value_case: none
# Use the "name" without the other context inputs i.e. namespace, tenant, environment, attributes
use_fullname: false
role_description: |
Used with AWS Workspaces Directory. The name of the role does not match the normal naming convention because this name is a requirement to work with the service. This role has to be used until AWS provides the respective service linked role.
# This will prevent the creation of a managed IAM policy
policy_document_count: 0
- arn:aws:iam::aws:policy/AmazonWorkSpacesServiceAccess
- arn:aws:iam::aws:policy/AmazonWorkSpacesSelfServiceAccess


terraform>= 1.0.0
aws>= 4.9.0


No providers.




No resources.


additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
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.
assume_role_actionsThe IAM action to be granted by the AssumeRole policylist(string)
assume_role_conditionsList of conditions for the assume role policy
test = string
variable = string
values = list(string)
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
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 delimiter
and treated as a single ID element.
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe additional descriptors to be output in the descriptors 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 is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
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
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
import_profile_nameAWS Profile name to use when importing a resourcestringnullno
import_role_arnIAM Role ARN to use when importing a resourcestringnullno
instance_profile_enabledCreate EC2 Instance Profile for the roleboolfalseno
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
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_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
managed_policy_arnsList of managed policies to attach to created roleset(string)[]no
max_session_durationThe maximum session duration (in seconds) for the role. Can have a value from 1 hour to 12 hoursnumber3600no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
pathPath to the role and policy. See IAM Identifiers for more information.string"/"no
permissions_boundaryARN of the policy that is used to set the permissions boundary for the rolestring""no
policy_descriptionThe description of the IAM policy that is visible in the IAM policy managerstring""no
policy_document_countNumber of policy documents (length of policy_documents list)number1no
policy_documentsList of JSON IAM policy documentslist(string)[]no
policy_nameThe name of the IAM policy that is visible in the IAM policy managerstringnullno
principalsMap of service name as key and a list of ARNs to allow assuming the role as value (e.g. map(AWS, list(arn:aws:iam:::role/admin)))map(list(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.
regionAWS Regionstringn/ayes
role_descriptionThe description of the IAM role that is visible in the IAM role managerstringn/ayes
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.
tags_enabledEnable/disable tags on IAM roles and policiesstringtrueno
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
use_fullnameIf set to 'true' then the full ID for the IAM role name (e.g. [var.namespace]-[var.environment]-[var.stage]) will be used.
Otherwise, will be used for the IAM role name.


roleIAM role module outputs