community.aws.iam_user_info (2.6.0) — module

Install collection

Install with ansible-galaxy collection install community.aws:==2.6.0

Add to requirements.yml

  collections:
    - name: community.aws
      version: 2.6.0

Description

This module can be used to gather IAM user(s) facts in AWS.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Note: These examples do not set authentication details, see the AWS Guide for details.
# Gather facts about "test" user.
- name: Get IAM user info
  community.aws.iam_user_info:
    name: "test"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Gather facts about all users in the "dev" group.
- name: Get IAM user info
  community.aws.iam_user_info:
    group: "dev"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Gather facts about all users with "/division_abc/subdivision_xyz/" path.
- name: Get IAM user info
  community.aws.iam_user_info:
    path: "/division_abc/subdivision_xyz/"

Inputs

    
name:
    description:
    - The name of the IAM user to look for.
    required: false
    type: str

path:
    default: /
    description:
    - The path to the IAM user. Mutually exclusive with C(group).
    - If specified, then would get all user names whose path starts with user provided
      value.
    required: false
    type: str

group:
    description:
    - The group name name of the IAM user to look for. Mutually exclusive with C(path).
    required: false
    type: str

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

profile:
    aliases:
    - aws_profile
    description:
    - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
      and I(security_token) options.
    type: str

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).
    type: dict

endpoint_url:
    aliases:
    - ec2_url
    - aws_endpoint_url
    - s3_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

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - '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.
    - The I(aws_access_key) and I(profile) options are mutually exclusive.
    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.
    - The I(aws_secret_key) and I(profile) options are mutually exclusive.
    type: str

security_token:
    aliases:
    - aws_session_token
    - session_token
    - 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.
    - The I(security_token) and I(profile) options are mutually exclusive.
    - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
    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

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

Outputs

iam_users:
  contains:
    arn:
      description: the ARN of the user
      returned: if user exists
      sample: arn:aws:iam::156360693172:user/dev/test_user
      type: str
    create_date:
      description: the datetime user was created
      returned: if user exists
      sample: '2016-05-24T12:24:59+00:00'
      type: str
    password_last_used:
      description: the last datetime the password was used by user
      returned: if password was used at least once
      sample: '2016-05-25T13:39:11+00:00'
      type: str
    path:
      description: the path to user
      returned: if user exists
      sample: /dev/
      type: str
    tags:
      description: User tags.
      returned: if user exists
      sample: '{"Env": "Prod"}'
      type: dict
    user_id:
      description: the unique user id
      returned: if user exists
      sample: AIDUIOOCQKTUGI6QJLGH2
      type: str
    user_name:
      description: the user name
      returned: if user exists
      sample: test_user
      type: str
  description: list of maching iam users
  returned: success
  type: complex