Documentation

iam_role - Manage AWS IAM roles

New in version 2.3.

Synopsis

  • Manage AWS IAM roles

Requirements (on host that executes module)

  • boto
  • boto3
  • botocore
  • python >= 2.6

Options

parameter required default choices comments
assume_role_policy_document
no
The trust relationship policy document that grants an entity permission to assume the role. This parameter is required when state: present.
aws_access_key
no
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.

aliases: ec2_access_key, access_key
aws_secret_key
no
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.

aliases: ec2_secret_key, secret_key
ec2_url
no
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_policy
yes
A list of managed policy ARNs or, since Ansible 2.4, a list of either managed policy ARNs or friendly names. To embed an inline policy, use iam_policy. To remove existing policies, use an empty list item.

aliases: managed_policies
name
yes
The name of the role to create.
path
no /
The path to the role. For more information about paths, see http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html.
profile
(added in 1.6)
no
Uses a boto profile. Only works with boto >= 2.24.0.
security_token
(added in 1.6)
no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

aliases: access_token
state
yes
  • present
  • absent
Create or remove the IAM role
validate_certs
(added in 1.5)
no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

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

# Create a role
- iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file','policy.json') }}"
    state: present

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

# Keep the role created above but remove all managed policies
- iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file','policy.json') }}"
    state: present
    managed_policy:
      -

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

Return Values

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

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


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_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
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.