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_group – Manage AWS IAM groups

Note

This plugin is part of the community.aws collection (version 1.5.0).

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_group.

New in version 1.0.0: of community.aws

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis 

Manage AWS IAM groups.

Requirements 

The below requirements are needed on the host that executes this module.

boto
boto3
botocore
python >= 2.6

Parameters 

Parameter	Comments
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. Only used for boto3 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.
managed_policies aliases: managed_policy list / elements=string	A list of managed policy ARNs or friendly names to attach to the role. To embed an inline policy, use community.aws.iam_policy.
name string / required	The name of the group to create.
profile aliases: aws_profile string	Uses a boto profile. Only works with boto >= 2.24.0. 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.
purge_policies aliases: purge_policy, purge_managed_policies boolean	When purge_policies=true any managed policies not listed in managed_policies will be detatched. Choices: no ← (default) yes
purge_users boolean	When purge_users=true users which are not included in users will be detached. Choices: no ← (default) yes
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	Create or remove the IAM group. Choices: present absent
users list / elements=string	A list of existing users to add as members of the group.
validate_certs boolean	When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0. Choices: no yes ← (default)

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
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/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

Examples 

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

- name: Create a group
  community.aws.iam_group:
    name: testgroup1
    state: present

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

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

- name: Remove all managed policies from an existing group with an empty list
  community.aws.iam_group:
    name: testgroup1
    state: present
    purge_policies: true

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

- name: Delete the group
  community.aws.iam_group:
    name: testgroup1
    state: absent

Return Values 

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

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

Authors

Nick Aslanidis (@naslanidis)
Maksym Postument (@infectsoldier)

community.aws.iam_group – Manage AWS IAM groups

Synopsis

Requirements

Parameters

Notes

Examples

Return Values