iam_group – Manage AWS IAM groups¶
New in version 2.4.
Requirements¶
The below requirements are needed on the host that executes this module.
- boto
- boto3
- botocore
- python >= 2.6
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key
-
|
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
-
|
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
-
|
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
-
|
A list of managed policy ARNs or friendly names to attach to the role. To embed an inline policy, use iam_policy.
|
|
name
-
/ required
|
The name of the group to create.
|
|
profile
-
added in 1.6 |
Uses a boto profile. Only works with boto >= 2.24.0.
|
|
purge_policy
-
|
Default: "no"
|
Deatach policy which not included in managed_policy list
|
purge_users
-
|
Default: "no"
|
Deatach users which not included in users list
|
region
-
|
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
aliases: aws_region, ec2_region |
|
security_token
-
added in 1.6 |
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
-
/ required
|
|
Create or remove the IAM group
|
users
-
|
A list of existing users to add as members of the group.
|
|
validate_certs
boolean
added in 1.5 |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Notes¶
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
- 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
orEC2_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.
# 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, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
group
complex
|
success |
dictionary containing all the group information
|
|
arn
string
|
the Amazon Resource Name (ARN) specifying the group
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
Sample:
2017-02-08T04:36:28+00:00
|
||
group_id
string
|
the stable and unique string identifying the group
Sample:
AGPAIDBWE12NSFINE55TM
|
||
group_name
string
|
the friendly name that identifies the group
Sample:
testgroup1
|
||
path
string
|
the path to the group
Sample:
/
|
||
users
complex
|
success |
list containing all the group members
|
|
arn
string
|
the Amazon Resource Name (ARN) specifying the user
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
Sample:
2017-02-08T04:36:28+00:00
|
||
path
string
|
the path to the user
Sample:
/
|
||
user_id
string
|
the stable and unique string identifying the user
Sample:
AIDAIZTPY123YQRS22YU2
|
||
user_name
string
|
the friendly name that identifies the user
Sample:
testgroup1
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Nick Aslanidis (@naslanidis)
- Maksym Postument (@infectsoldier)
Hint
If you notice any issues in this documentation you can edit this document to improve it.