W3cubDocs

/Ansible

iam_group - Manage AWS IAM groups

New in version 2.4.

Synopsis

  • Manage AWS IAM groups

Requirements (on host that executes module)

  • boto
  • boto3
  • botocore
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
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
 no
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
ec2_url
 no
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.
managed_policy
 no
A list of managed policy ARNs or friendly names to attach to the role. To embed an inline policy, use iam_policy.
name
 yes
The name of the group to create.
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
purge_policy
 no
Deatach policy which not included in managed_policy list
purge_users
 no
Deatach users which not included in users list
security_token
(added in 1.6)
 no
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
 yes
  • present
  • absent
Create or remove the IAM group
users
 no
A list of existing users to add as members of the group.
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Create a group
- iam_group:
    name: testgroup1
    state: present

# Create a group and attach a managed policy using its ARN
- iam_group:
    name: testgroup1
    managed_policy:
      - arn:aws:iam::aws:policy/AmazonSNSFullAccess
    state: present

# Create a group with users as members and attach a managed policy using its ARN
- iam_group:
    name: testgroup1
    managed_policy:
      - arn:aws:iam::aws:policy/AmazonSNSFullAccess
    users:
      - test_user1
      - test_user2
    state: present

# Remove all managed policies from an existing group with an empty list
- iam_group:
    name: testgroup1
    state: present
    purge_policy: true

# Remove all group members from an existing group
- iam_group:
    name: testgroup1
    managed_policy:
      - arn:aws:iam::aws:policy/AmazonSNSFullAccess
    purge_users: true
    state: present


# Delete the group
- iam_group:
    name: testgroup1
    state: absent

Return Values

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

name description returned type sample
group
dictionary containing all the group information
 success complex
contains:
name description returned type sample
path
the path to the group
 string /
group_id
the stable and unique string identifying the group
 string AGPAIDBWE12NSFINE55TM
create_date
the date and time, in ISO 8601 date-time format, when the group was created
 string 2017-02-08T04:36:28+00:00
arn
the Amazon Resource Name (ARN) specifying the group
 string arn:aws:iam::1234567890:group/testgroup1
group_name
the friendly name that identifies the group
 string testgroup1
users
list containing all the group members
 success complex
contains:
name description returned type sample
path
the path to the user
 string /
create_date
the date and time, in ISO 8601 date-time format, when the user was created
 string 2017-02-08T04:36:28+00:00
user_id
the stable and unique string identifying the user
 string AIDAIZTPY123YQRS22YU2
arn
the Amazon Resource Name (ARN) specifying the user
 string arn:aws:iam::1234567890:user/test_user1
user_name
the friendly name that identifies the user
 string testgroup1

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_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 http://boto.readthedocs.org/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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/iam_group_module.html