Try SpotterManage IAM users, groups, roles and keys
| "added in version" 1.0.0 of community.aws"
Authors: Jonathan I. Davila (@defionscode), Paul Seiffert (@seiffert)
Install with ansible-galaxy collection install community.aws:==0.1.2
collections:
- name: community.aws
version: 0.1.2Allows for the management of IAM users, user API keys, groups, roles.
# 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
name:
description:
- Name of IAM resource to create or identify.
required: true
type: str
path:
default: /
description:
- When creating or updating, specify the desired path of the resource.
- If I(state=present), it will replace the current path to match what is passed in
when they do not match.
type: str
state:
choices:
- present
- absent
- update
description:
- Whether to create, delete or update the IAM resource. Note, roles cannot be updated.
required: true
type: str
groups:
description:
- A list of groups the user should belong to. When I(state=update), will gracefully
remove groups not listed.
type: list
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
iam_type:
choices:
- user
- group
- role
description:
- Type of IAM resource.
required: true
type: str
new_name:
description:
- When I(state=update), will replace I(name) with I(new_name) on IAM resource.
type: str
new_path:
description:
- When I(state=update), will replace the path with new_path on the IAM resource.
type: str
password:
description:
- When I(type=user) and either I(state=present) or I(state=update), define the users
login password.
- Note that this will always return 'changed'.
type: str
key_count:
default: 1
description:
- When I(access_key_state=create) it will ensure this quantity of keys are present.
type: int
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
trust_policy:
description:
- The inline (JSON or YAML) trust policy document that grants an entity permission
to assume the role.
- Mutually exclusive with I(trust_policy_filepath).
type: dict
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
access_key_ids:
description:
- A list of the keys that you want affected by the I(access_key_state) parameter.
type: list
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
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
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
access_key_state:
choices:
- create
- remove
- active
- inactive
- Create
- Remove
- Active
- Inactive
description:
- When type is user, it creates, removes, deactivates or activates a user's access
key(s). Note that actions apply only to keys specified.
type: str
trust_policy_filepath:
description:
- The path to the trust policy document that grants an entity permission to assume
the role.
- Mutually exclusive with I(trust_policy).
type: str
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
role_result:
description: 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
type: str
roles:
description: 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-...
type: list