aws_iam_group Resource

Use the aws_iam_group InSpec audit resource to test properties of a single IAM group.

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

Install

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

For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.

An aws_iam_group resource block identifies a group by group name.

describe aws_iam_group('mygroup') do
  it { should exist }
end

# Hash syntax for group name

describe aws_iam_group(group_name: 'mygroup') do
  it { should exist }
end

group_name (required): This resource accepts a single parameter, the Group Name which uniquely identifies the IAM Group. This can be passed either as a string or as a group_name: 'value' key-value entry in a hash.

group_name: The group name.
group_id: The group ID.
arn: The Amazon Resource Name of the group.
users: Array of users associated with the group.
inline_policy_names: A list of inline policy names associated with the group.

Ensure group contains a certain user.

describe aws_iam_group('admin-group') do
  its('users') { should include 'deployment-service-account')}
end

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_group('AnExistingGroup') do
  it { should exist }
end

describe aws_iam_group('ANonExistentGroup') do
  it { should_not exist }
end

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