ansible / ansible.builtin / v2.9.17 / module / iam_role Manage AWS IAM roles | "added in version" 2.3 of ansible.builtin" Authors: Rob White (@wimnat) preview | supported by communityansible.builtin.iam_role (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Manage AWS IAM roles
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: Create a role with description iam_role: name: mynewrole assume_role_policy_document: "{{ lookup('file','policy.json') }}" description: This is My New Role
- name: "Create a role and attach a managed policy called 'PowerUserAccess'" iam_role: name: mynewrole assume_role_policy_document: "{{ lookup('file','policy.json') }}" managed_policy: - arn:aws:iam::aws:policy/PowerUserAccess
- name: Keep the role created above but remove all managed policies iam_role: name: mynewrole assume_role_policy_document: "{{ lookup('file','policy.json') }}" managed_policy: []
- name: Delete the role iam_role: name: mynewrole assume_role_policy_document: "{{ lookup('file', 'policy.json') }}" state: absent
name: description: - The name of the role to create. required: true path: default: / description: - The path to the role. For more information about paths, see U(https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html). state: choices: - present - absent default: present description: - Create or remove the IAM role region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str boundary: aliases: - boundary_policy_arn description: - Add the ARN of an IAM managed policy to restrict the permissions this role can pass on to IAM roles/users that it creates. - Boundaries cannot be set on Instance Profiles, so if this option is specified then C(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 U(https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) version_added: '2.7' version_added_collection: ansible.builtin aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict description: description: - Provide a description of the new role version_added: '2.5' version_added_collection: ansible.builtin aws_ca_bundle: description: - 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.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str managed_policy: aliases: - managed_policies description: - A list of managed policy ARNs or, since Ansible 2.4, a list of either managed policy ARNs or friendly names. To embed an inline policy, use M(iam_policy). To remove existing policies, use an empty list item. purge_policies: default: true description: - Detaches any managed policies not listed in the "managed_policy" option. Set to false if you want to attach policies elsewhere. type: bool version_added: '2.5' version_added_collection: ansible.builtin security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool create_instance_profile: default: true description: - Creates an IAM instance profile along with the role type: bool version_added: '2.5' version_added_collection: ansible.builtin assume_role_policy_document: description: - The trust relationship policy document that grants an entity permission to assume the role. - This parameter is required when C(state=present). debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
iam_role: contains: arn: description: the Amazon Resource Name (ARN) specifying the role returned: always sample: arn:aws:iam::1234567890:role/mynewrole type: str assume_role_policy_document: description: the policy that grants an entity permission to assume the role returned: always sample: statement: - action: sts:AssumeRole effect: Allow principal: service: ec2.amazonaws.com sid: '' version: '2012-10-17' type: str attached_policies: description: a list of dicts containing the name and ARN of the managed IAM policies attached to the role returned: always sample: - policy_arn: arn:aws:iam::aws:policy/PowerUserAccess policy_name: PowerUserAccess type: list create_date: description: the date and time, in ISO 8601 date-time format, when the role was created returned: always sample: '2016-08-14T04:36:28+00:00' type: str path: description: the path to the role returned: always sample: / type: str role_id: description: the stable and unique string identifying the role returned: always sample: ABCDEFF4EZ4ABCDEFV4ZC type: str role_name: description: the friendly name that identifies the role returned: always sample: myrole type: str description: dictionary containing the IAM Role data returned: success type: complex