.. _community.aws.iam_role_module: ********************** community.aws.iam_role ********************** **Manage AWS IAM roles** Version added: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - Manage AWS IAM roles. Requirements ------------ The below requirements are needed on the host that executes this module. - python >= 3.6 - boto3 >= 1.15.0 - botocore >= 1.18.0 Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
assume_role_policy_document
json
The trust relationship policy document that grants an entity permission to assume the role.
This parameter is required when state=present.
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.
Not used by boto 2 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
boundary
string
The ARN of an IAM managed policy to use to restrict the permissions this role can pass on to IAM roles/users that it creates.
Boundaries cannot be set on Instance Profiles, as such if this option is specified then create_instance_profile must be false.
This is intended for roles/users that have permissions to create new IAM objects.
For more information on boundaries, see https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html.

aliases: boundary_policy_arn
create_instance_profile
boolean
    Choices:
  • no
  • yes ←
Creates an IAM instance profile along with the role.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
delete_instance_profile
boolean
    Choices:
  • no ←
  • yes
When delete_instance_profile=true and state=absent deleting a role will also delete the instance profile created with the same name as the role.
Only applies when state=absent.
description
string
Provides a description of the role.
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
managed_policies
list / elements=string
A list of managed policy ARNs, managed policy ARNs or friendly names.
To remove all policies set purge_polices=true and managed_policies=[None].
To embed an inline policy, use community.aws.iam_policy.

aliases: managed_policy
max_session_duration
integer
The maximum duration (in seconds) of a session when assuming the role.
Valid values are between 1 and 12 hours (3600 and 43200 seconds).
name
string / required
The name of the role to create.
path
string
Default:
"/"
The path to the role. For more information about paths, see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html.
profile
string
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
purge_policies
boolean
    Choices:
  • no
  • yes
When purge_policies=true any managed policies not listed in managed_policies will be detatched.
By default purge_policies=true. In a release after 2022-06-01 this will be changed to purge_policies=false.

aliases: purge_policy, purge_managed_policies
purge_tags
boolean
    Choices:
  • no
  • yes ←
Remove tags not listed in tags when tags is specified.
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
state
string
    Choices:
  • present ←
  • absent
Create or remove the IAM role.
tags
dictionary
Tag dict to apply to the queue.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
wait
boolean
    Choices:
  • no
  • yes ←
When wait=True the module will wait for up to wait_timeout seconds for IAM role creation before returning.
wait_timeout
integer
Default:
120
How long (in seconds) to wait for creation / update to complete.

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`` - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. Examples -------- .. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. - name: Create a role with description and tags community.aws.iam_role: name: mynewrole assume_role_policy_document: "{{ lookup('file','policy.json') }}" description: This is My New Role tags: env: dev - name: "Create a role and attach a managed policy called 'PowerUserAccess'" community.aws.iam_role: name: mynewrole assume_role_policy_document: "{{ lookup('file','policy.json') }}" managed_policies: - arn:aws:iam::aws:policy/PowerUserAccess - name: Keep the role created above but remove all managed policies community.aws.iam_role: name: mynewrole assume_role_policy_document: "{{ lookup('file','policy.json') }}" managed_policies: [] - name: Delete the role community.aws.iam_role: name: mynewrole assume_role_policy_document: "{{ lookup('file', 'policy.json') }}" state: absent Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html
Key Returned Description
iam_role
complex
success
dictionary containing the IAM Role data
 
arn
string
always
the Amazon Resource Name (ARN) specifying the role

Sample:
arn:aws:iam::1234567890:role/mynewrole
 
assume_role_policy_document
string
always
the policy that grants an entity permission to assume the role

Sample:
{'statement': [{'action': 'sts:AssumeRole', 'effect': 'Allow', 'principal': {'service': 'ec2.amazonaws.com'}, 'sid': ''}], 'version': '2012-10-17'}
 
attached_policies
list
always
a list of dicts containing the name and ARN of the managed IAM policies attached to the role

Sample:
[{'policy_arn': 'arn:aws:iam::aws:policy/PowerUserAccess', 'policy_name': 'PowerUserAccess'}]
 
create_date
string
always
the date and time, in ISO 8601 date-time format, when the role was created

Sample:
2016-08-14T04:36:28+00:00
 
path
string
always
the path to the role

Sample:
/
 
role_id
string
always
the stable and unique string identifying the role

Sample:
ABCDEFF4EZ4ABCDEFV4ZC
 
role_name
string
always
the friendly name that identifies the role

Sample:
myrole
 
tags
dictionary
always
role tags

Sample:
{"Env": "Prod"}


Status ------ Authors ~~~~~~~ - Rob White (@wimnat)