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 module – Manage IAM users, groups, roles and keys

Note

This module is part of the community.aws collection (version 2.6.1).

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.

New in version 1.0.0: of community.aws

DEPRECATED
Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

DEPRECATED 

Removed in: version 3.0.0
Why: The iam module is based upon a deprecated version of the AWS SDK.
Alternative: Use community.aws.iam_user, community.aws.iam_group, community.aws.iam_role, community.aws.iam_policy and community.aws.iam_managed_policy modules.

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.

boto >= 2.49.0
boto3 >= 1.15.0
botocore >= 1.18.0
python >= 3.6

Parameters 

Parameter	Comments
access_key_ids list / elements=string	A list of the keys that you want affected by the access_key_state parameter.
access_key_state string	When type is user, it creates, removes, deactivates or activates a user’s access key(s). Note that actions apply only to keys specified. Choices: create remove active inactive Create Remove Active Inactive
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. Not used by boto 2 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.
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
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.
groups list / elements=string	A list of groups the user should belong to. When state=update, will gracefully remove groups not listed.
iam_type string / required	Type of IAM resource. Choices: user group role
key_count integer	When access_key_state=create it will ensure this quantity of keys are present. Default: 1
name string / required	Name of IAM resource to create or identify.
new_name string	When state=update, will replace name with new_name on IAM resource.
new_path string	When state=update, will replace the path with new_path on the IAM resource.
password string	When type=user and either state=present or state=update, define the users login password. Note that this will always return ‘changed’.
path string	When creating or updating, specify the desired path of the resource. If state=present, it will replace the current path to match what is passed in when they do not match. Default: “/”
profile aliases: aws_profile string	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.
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 / required	Whether to create, delete or update the IAM resource. Note, roles cannot be updated. Choices: present absent update
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	When to update user passwords. update_password=always will ensure the password is set to password. update_password=on_create will only set the password for newly created users. Choices: always ← (default) on_create
validate_certs boolean	When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices: no yes ← (default)

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_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
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

Examples 

# Basic user creation example
- name: Create two new IAM users with API keys
  community.aws.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.
- name: Create Two Groups, Mario and Luigi
  community.aws.iam:
    iam_type: group
    name: "{{ item }}"
    state: present
  loop:
     - Mario
     - Luigi
  register: new_groups

- name: Update user
  community.aws.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
  community.aws.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	Description
role_result string	the IAM.role dict returned by Boto Returned: if iam_type=role and state=present 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 / elements=string	a list containing the name of the currently defined roles Returned: if iam_type=role and state=present Sample: [“my-new-role”, “my-existing-role-1”, “my-existing-role-2”, “my-existing-role-3”, “my-existing-role-…”]

Status 

This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.

Authors

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

Collection links

Issue Tracker Repository (Sources)