aws_iam_roles Resource

[edit on GitHub]

Use the aws_iam_roles InSpec audit resource to test properties of a collection of AWS IAM Roles.

For additional information, including details on parameters and properties, see the AWS documentation on IAM Roles.

Installation

This resource is available in the Chef InSpec AWS resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your AWS environment for InSpec and creating an InSpec profile that uses the InSpec AWS resource pack.

Syntax

An aws_iam_roles resource block returns all IAM Roles and allows the testing of that group of Roles.

describe aws_iam_roles do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

paths

The path to the role.

role_names

The name of the role.

role_ids

The ID of the role.

arns

The Amazon Resource Name (ARN) specifying the role.

create_date

The date and time, in ISO 8601 date-time format, when the role was created.

assume_role_policy_document

The policy that grants an entity permission to assume the role.

description

The description of the role.

max_session_duration

The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

permissions_boundary_type

The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.

permissions_boundary_arn

The ARN of the policy used to set the permissions boundary for the user or role.

entries

Provides access to the raw results of the query, which can be treated as an array of hashes.

Examples

Ensure the Role ‘RDS-RW’ exists.

describe aws_iam_roles do
  its('role_names') { should include 'RDS-RW' }
end

Ensure no Roles have max_session_duration greater or equal to 2hrs.

describe aws_iam_roles.where{ max_session_duration >= (60*120) } do
  it { should_not exist }
end

Matchers

For a full list of available matchers, please visit our matchers page.

exist

The exists matcher tests if the filtered IAM User(s) exists.

describe aws_iam_roles.where( <property>: <param>) do
  it { should exist }
end

You may also use it { should_not exist }.

AWS Permissions

Your Principal will need the IAM:Client:ListRolesResponse action with Effect set to Allow.

You can find detailed documentation at Actions, Resources, and Condition Keys for Amazon EC2.