community.aws.iam_role_info – Gather information on IAM roles
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_role_info.
New in version 1.0.0: of community.aws
Synopsis
- Gathers information about IAM roles.
- This module was called
iam_role_factsbefore Ansible 2.9. The usage did not change.
Requirements
The below requirements are needed on the host that executes this module.
- boto
- boto3
- python >= 2.6
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| aws_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.
aliases: ec2_access_key, access_key |
|
| 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
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.
aliases: ec2_secret_key, secret_key |
|
| 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.
|
| ec2_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.
aliases: aws_endpoint_url, endpoint_url |
|
| name
string
|
Name of a role to search for.
Mutually exclusive with path_prefix.
aliases: role_name |
|
| path_prefix
string
|
Prefix of role to restrict IAM role search for.
Mutually exclusive with name.
|
|
| 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.
aliases: aws_profile |
|
| 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
aliases: aws_region, ec2_region |
|
| security_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.
aliases: aws_security_token, access_token |
|
| validate_certs
boolean
|
|
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_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_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_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples
- name: find all existing IAM roles
community.aws.iam_role_info:
register: result
- name: describe a single role
community.aws.iam_role_info:
name: MyIAMRole
- name: describe all roles matching a path prefix
community.aws.iam_role_info:
path_prefix: /application/path
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
| iam_roles
complex
|
always |
List of IAM roles
|
||
| arn
string
|
always |
Amazon Resource Name for IAM role.
Sample:
arn:aws:iam::123456789012:role/AnsibleTestRole
|
||
| assume_role_policy_document
string
|
always |
Policy Document describing what can assume the role.
|
||
| create_date
string
|
always |
Date IAM role was created.
Sample:
2017-10-23T00:05:08+00:00
|
||
| inline_policies
list / elements=string
|
always |
List of names of inline policies.
|
||
| instance_profiles
complex
|
always |
List of attached instance profiles.
|
||
| arn
string
|
always |
Amazon Resource Name for the instance profile.
Sample:
arn:aws:iam::123456789012:instance-profile/AnsibleTestEC2Policy
|
||
| create_date
string
|
always |
Date instance profile was created.
Sample:
2017-10-23T00:05:08+00:00
|
||
| instance_profile_id
string
|
always |
Amazon Identifier for the instance profile.
Sample:
AROAII7ABCD123456EFGH
|
||
| instance_profile_name
string
|
always |
Name of instance profile.
Sample:
AnsibleTestEC2Policy
|
||
| path
string
|
always |
Path of instance profile.
Sample:
/
|
||
| roles
list / elements=string
|
always |
List of roles associated with this instance profile.
|
||
| managed_policies
complex
|
always |
List of attached managed policies.
|
||
| policy_arn
string
|
always |
Amazon Resource Name for the policy.
Sample:
arn:aws:iam::123456789012:policy/AnsibleTestEC2Policy
|
||
| policy_name
string
|
always |
Name of managed policy.
Sample:
AnsibleTestEC2Policy
|
||
| path
string
|
always |
Path of role.
Sample:
/
|
||
| role_id
string
|
always |
Amazon Identifier for the role.
Sample:
AROAII7ABCD123456EFGH
|
||
| role_name
string
|
always |
Name of the role.
Sample:
AnsibleTestRole
|
||
| tags
dictionary
|
always |
Role tags.
Sample:
{"Env": "Prod"}
|
||
Authors
- Will Thames (@willthames)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/iam_role_info_module.html