amazon.aws.iam_group module – Manage AWS IAM groups
Note
This module is part of the amazon.aws collection (version 7.6.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 |
|---|---|
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 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 |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
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. |
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
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: |
|
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 The alias |
|
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. |
|
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 The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
When purge_policies=true any managed policies not listed in managed_policies will be detatched. Choices:
|
|
When purge_users=true users which are not included in users will be detached. Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
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 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 |
|
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 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 |
|
Create or remove the IAM group. Choices:
|
|
A list of existing users to add as members of the group. Default: |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
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 |
|---|---|
dictionary containing all the group information including group membership Returned: success |
|
list containing basic information about managed policies attached to the group. Returned: success |
|
the Amazon Resource Name (ARN) specifying the managed policy. Returned: success Sample: |
|
the friendly name that identifies the policy. Returned: success Sample: |
|
dictionary containing all the group information Returned: success |
|
the Amazon Resource Name (ARN) specifying the group Returned: success Sample: |
|
the date and time, in ISO 8601 date-time format, when the group was created Returned: success Sample: |
|
the stable and unique string identifying the group Returned: success Sample: |
|
the friendly name that identifies the group Returned: success Sample: |
|
the path to the group Returned: success Sample: |
|
list containing all the group members Returned: success |
|
the Amazon Resource Name (ARN) specifying the user Returned: success Sample: |
|
the date and time, in ISO 8601 date-time format, when the user was created Returned: success Sample: |
|
the path to the user Returned: success Sample: |
|
the stable and unique string identifying the user Returned: success Sample: |
|
the friendly name that identifies the user Returned: success Sample: |