aws_iam_role resource

[edit on GitHub]

Use the aws_iam_role InSpec audit resource to test properties of an AWS IAM Role.

Syntax

An aws_iam_role resource block declares the tests for a single AWS IAM Role by Role Name.

describe aws_iam_role(role_name: 'my-role') do
    it { should exist }
end

Parameters

role_name (required)

This resource accepts a single parameter, the Role Name which uniquely identifies the Role. This can be passed either as a string or as a role_name: 'value' key-value entry in a hash.

See also the AWS documentation on IAM Roles.

Properties

Property	Description
path	The path to the role.
role_name	The name of the role.
role_id	The id of the role.
arn	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.
inline_policies	A list of inline policy names associated with the described role.
attached_policies_name	A list of attached policy names associated with the described role.
attached_policies_arn	A list of attached policy ARNs associated with the described role.

Examples

Test that an IAM Role exists

describe aws_iam_role(role_name: aws_iam_role_name) do
    it               { should exist }
    its('role_name') { should eq aws_iam_role_name }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our matchers page.

exist

The control will pass if the describe returns at least one result.

Use should_not to test the entity should not exist.

describe aws_iam_role('AnExistingRole') do
  it { should exist }
end

describe aws_iam_role('ANonExistentRole') do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the following permissions action set to allow: iam:GetRole