amazon.aws.iam_group module – Manage AWS IAM groups

Note

This module is part of the amazon.aws collection (version 8.2.1).

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 amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.iam_group.

New in community.aws 1.0.0

Synopsis 

Manage AWS IAM groups.

Requirements 

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Parameters 

Parameter	Comments
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` or `EC2_ACCESS_KEY` environment variables may also be used in decreasing order of preference. The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the `EC2_ACCESS_KEY` environment variable has been deprecated and will be removed in a release after 2024-12-01.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The `AWS_CA_BUNDLE` environment variable may also be used.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
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: `false` ← (default) `true`
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The `AWS_URL` or `EC2_URL` environment variables may also be used, in decreasing order of preference. The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the `EC2_URL` environment variable has been deprecated and will be removed in a release after 2024-12-01.
managed_policies aliases: managed_policy list / elements=string	A list of managed policy ARNs or friendly names to attach to the role. If known, it is recommended to use ARNs rather than friendly names to avoid additional lookups. To embed an inline policy, use amazon.aws.iam_policy. Default: `[]`
name aliases: group_name string / required	The name of the group. Note: Group names are unique within an account. Paths (`path`) do not affect the uniqueness requirements of `name`. For example it is not permitted to have both `/Path1/MyGroup` and `/Path2/MyGroup` in the same account. The alias `group_name` was added in release 7.2.0.
path aliases: prefix, path_prefix string added in amazon.aws 7.1.0	The group path. For more information about IAM paths, see the AWS IAM identifiers documentation https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html.
profile aliases: aws_profile string	A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The `AWS_PROFILE` environment variable may also be used. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
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: `false` ← (default) `true`
purge_users boolean	When `purge_users=true` users which are not included in users will be detached. Choices: `false` ← (default) `true`
region aliases: aws_region, ec2_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The `AWS_REGION` or `EC2_REGION` environment variables may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The `ec2_region` alias has been deprecated and will be removed in a release after 2024-12-01 Support for the `EC2_REGION` environment variable has been deprecated and will be removed in a release after 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, or `EC2_SECRET_KEY` environment variables may also be used in decreasing order of preference. The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the `EC2_SECRET_KEY` environment variable has been deprecated and will be removed in a release after 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` or `EC2_SECURITY_TOKEN` environment variables may also be used in decreasing order of preference. The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the `EC2_SECRET_KEY` and `AWS_SECURITY_TOKEN` environment variables has been deprecated and will be removed in a release after 2024-12-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. Default: `[]`
validate_certs boolean	When set to `false`, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: `false` `true` ← (default)

Notes 

Note

Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples 

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

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

- name: Create a group and attach a managed policy using its ARN
  amazon.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
  amazon.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
  amazon.aws.iam_group:
    name: testgroup1
    state: present
    purge_policies: true

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

- name: Delete the group
  amazon.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
attached_policies complex added in amazon.aws 7.1.0	List containing basic information about managed policies attached to the group. Returned: success
policy_arn string	The Amazon Resource Name (ARN) specifying the managed policy. Returned: success Sample: `"arn:aws:iam::123456789012:policy/test_policy"`
policy_name string	The friendly name that identifies the policy. Returned: success Sample: `"test_policy"`
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: `"AGPA12345EXAMPLE54321"`
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: `"AIDA12345EXAMPLE54321"`
user_name string	The friendly name that identifies the user. Returned: success Sample: `"testgroup1"`

Authors

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

amazon.aws.iam_group module – Manage AWS IAM groups

Synopsis

Requirements

Parameters

Notes

Examples

Return Values