You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.aws.iam_role – Manage AWS IAM roles

Note

This plugin is part of the community.aws collection (version 1.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.iam_role.

New in version 1.0.0: of community.aws

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis 

Manage AWS IAM roles.

Requirements 

The below requirements are needed on the host that executes this module.

boto
boto3
botocore
python >= 2.6

Parameters 

Parameter	Comments
assume_role_policy_document json	The trust relationship policy document that grants an entity permission to assume the role. This parameter is required when state=present.
aws_access_key aliases: ec2_access_key, access_key string	AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key aliases: ec2_secret_key, secret_key string	AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
boundary aliases: boundary_policy_arn string	The ARN of an IAM managed policy to use to restrict the permissions this role can pass on to IAM roles/users that it creates. Boundaries cannot be set on Instance Profiles, as such if this option is specified then create_instance_profile must be `false`. This is intended for roles/users that have permissions to create new IAM objects. For more information on boundaries, see https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html. Requires botocore 1.10.57 or above.
create_instance_profile boolean	Creates an IAM instance profile along with the role. Choices: no yes ← (default)
debug_botocore_endpoint_logs boolean	Use a botocore.endpoint logger to parse the unique (rather than total) “resource:action” API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. Choices: no ← (default) yes
delete_instance_profile boolean	When delete_instance_profile=true and state=absent deleting a role will also delete the instance profile created with the same name as the role. Only applies when state=absent. Choices: no ← (default) yes
description string	Provides a description of the role.
ec2_url aliases: aws_endpoint_url, endpoint_url string	Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
managed_policies aliases: managed_policy list / elements=string	A list of managed policy ARNs or, since Ansible 2.4, a list of either managed policy ARNs or friendly names. To remove all policies set purge_polices=true and managed_policies=[None]. To embed an inline policy, use community.aws.iam_policy.
max_session_duration integer	The maximum duration (in seconds) of a session when assuming the role. Valid values are between 1 and 12 hours (3600 and 43200 seconds).
name string / required	The name of the role to create.
path string	The path to the role. For more information about paths, see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html. Default: “/”
profile aliases: aws_profile string	Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
purge_policies aliases: purge_policy, purge_managed_policies boolean	When purge_policies=true any managed policies not listed in managed_policies will be detatched. By default purge_policies=true. In Ansible 2.14 this will be changed to purge_policies=false. Choices: no yes
purge_tags boolean	Remove tags not listed in tags when tags is specified. Choices: no yes ← (default)
region aliases: aws_region, ec2_region string	The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
security_token aliases: aws_security_token, access_token string	AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
state string	Create or remove the IAM role. Choices: present ← (default) absent
tags dictionary	Tag dict to apply to the queue. Requires botocore 1.12.46 or above.
validate_certs boolean	When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0. Choices: no yes ← (default)

Notes 

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples 

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create a role with description and tags
  community.aws.iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file','policy.json') }}"
    description: This is My New Role
    tags:
      env: dev

- name: "Create a role and attach a managed policy called 'PowerUserAccess'"
  community.aws.iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file','policy.json') }}"
    managed_policies:
      - arn:aws:iam::aws:policy/PowerUserAccess

- name: Keep the role created above but remove all managed policies
  community.aws.iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file','policy.json') }}"
    managed_policies: []

- name: Delete the role
  community.aws.iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file', 'policy.json') }}"
    state: absent

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
iam_role complex	dictionary containing the IAM Role data Returned: success
arn string	the Amazon Resource Name (ARN) specifying the role Returned: always Sample: “arn:aws:iam::1234567890:role/mynewrole”
assume_role_policy_document string	the policy that grants an entity permission to assume the role Returned: always Sample: {“statement”: [{“action”: “sts:AssumeRole”, “effect”: “Allow”, “principal”: {“service”: “ec2.amazonaws.com”}, “sid”: “”}], “version”: “2012-10-17”}
attached_policies list / elements=string	a list of dicts containing the name and ARN of the managed IAM policies attached to the role Returned: always Sample: [{“policy_arn”: “arn:aws:iam::aws:policy/PowerUserAccess”, “policy_name”: “PowerUserAccess”}]
create_date string	the date and time, in ISO 8601 date-time format, when the role was created Returned: always Sample: “2016-08-14T04:36:28+00:00”
path string	the path to the role Returned: always Sample: “/”
role_id string	the stable and unique string identifying the role Returned: always Sample: “ABCDEFF4EZ4ABCDEFV4ZC”
role_name string	the friendly name that identifies the role Returned: always Sample: “myrole”
tags dictionary	role tags Returned: always Sample: “{\”Env\”: \”Prod\”}”

Authors

Rob White (@wimnat)

community.aws.iam_role – Manage AWS IAM roles

Synopsis

Requirements

Parameters

Notes

Examples

Return Values