aws_iam_account_alias Resource

[edit on GitHub]

Use the aws_iam_account_alias InSpec audit resource to test properties of the AWS IAM account alias.

For additional information, including details on parameters and properties, see the AWS documentation on Account Aliases.

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_account_alias resource block may be used to perform tests on details of the AWS account alias.

describe aws_iam_account_alias do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

alias

String containing the Alias of the account.

Examples

Check that the account alias has not be set.

describe aws_iam_account_alias do
  it { should_not exist }
end

Test if the account alias starts with expected prefix.

describe aws_iam_account_alias do
  it           { should exist }
  its('alias') { should match /^chef-/ }
end

Matchers

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_account_alias do
  it { should exist }
end

AWS Permissions

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