inspec/docs/resources/aws_iam_users.md
Clinton Wolfe 82dc6f3ec7
Documentation for existing resources
* Update docs in source to use matcher-style calls, not properties-as-predicates

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

* Main doc file for aws_iam_user

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

* Add documentation for existing resources

This adds documentation for the following resources, including custom matchers:

  - aws_ec2_instance
  - aws_iam_access_key
  - aws_iam_password_policy
  - aws_iam_root_user
  - aws_iam_users

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* Fix `aws_iam_users` example (Console + No MFA) (#104)

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* Correct copypasta

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

* Remove misleading singular matcher information from the plural docs for aws_iam_users

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

* Correct `aws-iam-userss` typo (#105)

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* Add EC2 instance state info

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

* test commit

Signed-off-by: kgarmoe <kgarmoe@chef.io>

* copy edits

Signed-off-by: kgarmoe <kgarmoe@chef.io>

* Yikes, forgot to save after correcting a merge conflict

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2017-10-27 16:31:36 -04:00

1.4 KiB

title
About the aws_iam_users Resource

aws_iam_users

Use the aws_iam_users InSpec audit resource to test properties of a all or multiple users.

To test properties of a single user, use the aws_iam_user resource.

To test properties of the special AWS root user (which owns the account), use the aws_iam_root_user resource.


Syntax

An aws_iam_users resource block users a filter to select a group of users and then tests that group

describe aws_iam_users.where(has_mfa_enabled?: false) do
  it { should_not exist }
end

Examples

The following examples show how to use this InSpec audit resource.

Test that all users have Multi-Factor Authentication enabled

describe aws_iam_users.where(has_mfa_enabled?: false) do
  it { should_not exist }
end

Test that at least one user has a console password to log into the AWS web console

describe aws_iam_users.where(has_console_password?: true) do
  it { should exist }
end

Test that all users that have a console password have Multi-Factor Authentication enabled

console_users_without_mfa = aws_iam_users
                            .where(has_console_password?: true)
                            .where(has_mfa_enabled?: false)

describe console_users_without_mfa do
  it { should_not exist }
end

Matchers

This InSpec audit resource has no specific matchers.