Try SpotterManage AWS IAM users
| "added in version" 1.0.0 of community.aws"
Authors: Josh Souza (@joshsouza)
Install with ansible-galaxy collection install community.aws:==3.4.0
collections:
- name: community.aws
version: 3.4.0A module to manage AWS IAM users.
The module does not manage groups that users belong to, groups memberships can be managed using M(community.aws.iam_group).
# 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 community.aws.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
name:
description:
- The name of the user to create.
required: true
type: str
tags:
description:
- Tag dict to apply to the user.
required: false
type: dict
version_added: 2.1.0
version_added_collection: community.aws
wait:
default: true
description:
- When I(wait=True) the module will wait for up to I(wait_timeout) seconds for IAM
user creation before returning.
type: bool
version_added: 2.2.0
version_added_collection: community.aws
state:
choices:
- present
- absent
description:
- Create or remove the IAM user.
required: true
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
password:
description:
- The password to apply to the user.
required: false
type: str
version_added: 2.2.0
version_added_collection: community.aws
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
purge_tags:
default: true
description:
- Remove tags not listed in I(tags) when tags is specified.
type: bool
version_added: 2.1.0
version_added_collection: community.aws
wait_timeout:
default: 120
description:
- How long (in seconds) to wait for creation / updates to complete.
type: int
version_added: 2.2.0
version_added_collection: community.aws
aws_ca_bundle:
description:
- 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.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
purge_policies:
aliases:
- purge_policy
- purge_managed_policies
default: false
description:
- When I(purge_policies=true) any managed policies not listed in I(managed_policies)
will be detached.
required: false
type: bool
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
remove_password:
description:
- Option to delete user login passwords.
- This field is mutually exclusive to I(password).
type: bool
version_added: 2.2.0
version_added_collection: community.aws
update_password:
choices:
- always
- on_create
default: always
description:
- When to update user passwords.
- I(update_password=always) will ensure the password is set to I(password).
- I(update_password=on_create) will only set the password for newly created users.
type: str
version_added: 2.2.0
version_added_collection: community.aws
managed_policies:
aliases:
- managed_policy
description:
- A list of managed policy ARNs or friendly names to attach to the user.
- To embed an inline policy, use M(community.aws.iam_policy).
elements: str
required: false
type: list
password_reset_required:
default: false
description:
- Defines if the user is required to set a new password after login.
required: false
type: bool
version_added: 3.1.0
version_added_collection: community.aws
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
user:
contains:
arn:
description: the Amazon Resource Name (ARN) specifying the user
sample: arn:aws:iam::1234567890:user/testuser1
type: str
create_date:
description: the date and time, in ISO 8601 date-time format, when the user
was created
sample: '2017-02-08T04:36:28+00:00'
type: str
path:
description: the path to the user
sample: /
type: str
tags:
description: user tags
returned: always
sample:
Env: Prod
type: dict
user_id:
description: the stable and unique string identifying the user
sample: AGPAIDBWE12NSFINE55TM
type: str
user_name:
description: the friendly name that identifies the user
sample: testuser1
type: str
description: dictionary containing all the user information
returned: success
type: complex