.. _community.aws.iam_user_module: ********************** community.aws.iam_user ********************** **Manage AWS IAM users** Version added: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - A module to manage AWS IAM users. - The module does not manage groups that users belong to, groups memberships can be managed using `iam_group`. Requirements ------------ The below requirements are needed on the host that executes this module. - python >= 3.6 - boto3 >= 1.15.0 - botocore >= 1.18.0 Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
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.
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.

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

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    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.

aliases: aws_endpoint_url, endpoint_url
managed_policies
list / elements=string
A list of managed policy ARNs or friendly names to attach to the user.
To embed an inline policy, use community.aws.iam_policy.

aliases: managed_policy
name
string / required
The name of the user to create.
password
string
added in 2.2.0
The password to apply to the user.
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.

aliases: aws_profile
purge_policies
boolean
    Choices:
  • no ←
  • yes
When purge_policies=true any managed policies not listed in managed_policies will be detached.

aliases: purge_policy, purge_managed_policies
purge_tags
boolean
added in 2.1.0
    Choices:
  • no
  • yes ←
Remove tags not listed in tags when tags is specified.
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
remove_password
boolean
added in 2.2.0
    Choices:
  • no
  • yes
Option to delete user login passwords.
This field is mutually exclusive to password.
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.
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.

aliases: aws_security_token, access_token
state
string / required
    Choices:
  • present
  • absent
Create or remove the IAM user.
tags
dictionary
added in 2.1.0
Tag dict to apply to the user.
update_password
string
added in 2.2.0
    Choices:
  • always ←
  • on_create
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.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
wait
boolean
added in 2.2.0
    Choices:
  • no
  • yes ←
When wait=True the module will wait for up to wait_timeout seconds for IAM user creation before returning.
wait_timeout
integer
added in 2.2.0
 Default:
120
How long (in seconds) to wait for creation / updates to complete.

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`` - 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 -------- .. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. # Note: This module does not allow management of groups that users belong to. # Groups should manage their membership directly using `iam_group`, # as users belong to them. - name: Create a user community.aws.iam_user: name: testuser1 state: present - name: Create a user with a password community.aws.iam_user: name: testuser1 password: SomeSecurePassword state: present - name: Create a user and attach a managed policy using its ARN community.aws.iam_user: name: testuser1 managed_policies: - arn:aws:iam::aws:policy/AmazonSNSFullAccess state: present - name: Remove all managed policies from an existing user with an empty list community.aws.iam_user: name: testuser1 state: present purge_policies: true - name: Create user with tags community.aws.iam_user: name: testuser1 state: present tags: Env: Prod - name: Delete the user community.aws.iam_user: name: testuser1 state: absent Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html
Key Returned Description
user
complex
success
dictionary containing all the user information
 
arn
string
the Amazon Resource Name (ARN) specifying the user

Sample:
arn:aws:iam::1234567890:user/testuser1
 
create_date
string
the date and time, in ISO 8601 date-time format, when the user was created

Sample:
2017-02-08T04:36:28+00:00
 
path
string
the path to the user

Sample:
/
 
tags
dictionary
always
user tags

Sample:
{"Env": "Prod"}
 
user_id
string
the stable and unique string identifying the user

Sample:
AGPAIDBWE12NSFINE55TM
 
user_name
string
the friendly name that identifies the user

Sample:
testuser1


Status ------ Authors ~~~~~~~ - Josh Souza (@joshsouza)