- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# iam – Manage IAM users, groups, roles and keys

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Allows for the management of IAM users, user API keys, groups, roles.

## Requirements

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

- python >= 2.6
- boto

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
access_key_ids list |  | A list of the keys that you want impacted by the access_key_state parameter.
access_key_state string | Choices: create remove active inactive Create Remove Active Inactive | When type is user, it creates, removes, deactivates or activates a user's access key(s). Note that actions apply only to keys specified.
aws_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. aliases: ec2_access_key, access_key
aws_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. aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs boolean added in 2.8 | Choices: no ← yes | 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.
ec2_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.
groups list |  | A list of groups the user should belong to. When update, will gracefully remove groups not listed.
iam_type string | Choices: user group role | Type of IAM resource
key_count integer | Default: 1 | When access_key_state is create it will ensure this quantity of keys are present. Defaults to 1.
name string / required |  | Name of IAM resource to create or identify
new_name string |  | When state is update, will replace name with new_name on IAM resource
new_path string |  | When state is update, will replace the path with new_path on the IAM resource
password string |  | When type is user and state is present, define the users login password. Also works with update. Note that always returns changed.
path string | Default: "/" | When creating or updating, specify the desired path of the resource. If state is present, it will replace the current path to match what is passed in when they do not match.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
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 aliases: aws_region, ec2_region
security_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. aliases: access_token
state string / required | Choices: present absent update | Whether to create, delete or update the IAM resource. Note, roles cannot be updated.
trust_policy dictionary |  | The inline (JSON or YAML) trust policy document that grants an entity permission to assume the role. Mutually exclusive with `trust_policy_filepath`.
trust_policy_filepath string |  | The path to the trust policy document that grants an entity permission to assume the role. Mutually exclusive with `trust_policy`.
update_password string | Choices: always ← on_create | `always` will update passwords if they differ. `on_create` will only set the password for newly created users.
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

## Notes

Note

- Currently boto does not support the removal of Managed Policies, the module will error out if your user/group/role has managed policies when you try to do state=absent. They will need to be removed manually.
- 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 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

    # Basic user creation example
    tasks:
    - name: Create two new IAM users with API keys
      iam:
        iam_type: user
        name: "{{ item }}"
        state: present
        password: "{{ temp_pass }}"
        access_key_state: create
      loop:
        - jcleese
        - mpython

    # Advanced example, create two new groups and add the pre-existing user
    # jdavila to both groups.
    task:
    - name: Create Two Groups, Mario and Luigi
      iam:
        iam_type: group
        name: "{{ item }}"
        state: present
      loop:
         - Mario
         - Luigi
      register: new_groups

    - name:
      iam:
        iam_type: user
        name: jdavila
        state: update
        groups: "{{ item.created_group.group_name }}"
      loop: "{{ new_groups.results }}"

    # Example of role with custom trust policy for Lambda service
    - name: Create IAM role with custom trust relationship
      iam:
        iam_type: role
        name: AAALambdaTestRole
        state: present
        trust_policy:
          Version: '2012-10-17'
          Statement:
          - Action: sts:AssumeRole
            Effect: Allow
            Principal:
              Service: lambda.amazonaws.com

## Return Values

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

Key | Returned | Description
--- | --- | ---
role_result string | if iam_type=role and state=present | the IAM.role dict returned by Boto Sample: {'arn': 'arn:aws:iam::A1B2C3D4E5F6:role/my-new-role', 'assume_role_policy_document': '...truncated...', 'create_date': '2017-09-02T14:32:23Z', 'path': '/', 'role_id': 'AROAA1B2C3D4E5F6G7H8I', 'role_name': 'my-new-role'}
roles list | if iam_type=role and state=present | a list containing the name of the currently defined roles Sample: ['my-new-role', 'my-existing-role-1', 'my-existing-role-2', 'my-existing-role-3', 'my-existing-role-...']

## Status

- This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Community. [community]

### Authors

- Jonathan I. Davila (@defionscode)
- Paul Seiffert (@seiffert)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.