ansible / ansible.builtin / v2.9.17 / module / iam Manage IAM users, groups, roles and keys | "added in version" 2.0 of ansible.builtin" Authors: Jonathan I. Davila (@defionscode), Paul Seiffert (@seiffert) stableinterface | supported by communityansible.builtin.iam (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Allows for the management of IAM users, user API keys, groups, roles.
name: description: - Name of IAM resource to create or identify required: true type: str path: default: / description: - When creating or updating, specify the desired path of the resource. If state is present, it will replace the current path to match what is passed in when they do not match. type: str state: choices: - present - absent - update description: - Whether to create, delete or update the IAM resource. Note, roles cannot be updated. required: true type: str groups: description: - A list of groups the user should belong to. When update, will gracefully remove groups not listed. type: list 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 iam_type: choices: - user - group - role description: - Type of IAM resource type: str new_name: description: - When state is update, will replace name with new_name on IAM resource type: str new_path: description: - When state is update, will replace the path with new_path on the IAM resource type: str password: description: - When type is user and state is present, define the users login password. Also works with update. Note that always returns changed. type: str key_count: default: 1 description: - When access_key_state is create it will ensure this quantity of keys are present. Defaults to 1. type: int 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 trust_policy: description: - The inline (JSON or YAML) trust policy document that grants an entity permission to assume the role. Mutually exclusive with C(trust_policy_filepath). type: dict version_added: '2.2' 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 access_key_ids: description: - A list of the keys that you want impacted by the access_key_state parameter. type: list 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 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 update_password: choices: - always - on_create default: always description: - C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users. type: str access_key_state: choices: - create - remove - active - inactive - Create - Remove - Active - Inactive description: - When type is user, it creates, removes, deactivates or activates a user's access key(s). Note that actions apply only to keys specified. type: str trust_policy_filepath: description: - The path to the trust policy document that grants an entity permission to assume the role. Mutually exclusive with C(trust_policy). type: str version_added: '2.2' version_added_collection: ansible.builtin 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
role_result: description: the IAM.role dict returned by Boto returned: if iam_type=role and state=present sample: arn: arn:aws:iam::A1B2C3D4E5F6:role/my-new-role assume_role_policy_document: '...truncated...' create_date: '2017-09-02T14:32:23Z' path: / role_id: AROAA1B2C3D4E5F6G7H8I role_name: my-new-role type: str roles: description: a list containing the name of the currently defined roles returned: if iam_type=role and state=present sample: - my-new-role - my-existing-role-1 - my-existing-role-2 - my-existing-role-3 - my-existing-role-... type: list