aws_iam_service_linked_role_deletion_status Resource
Use the aws_iam_service_linked_role_deletion_status
InSpec audit resource to test the deletion status of a single AWS IAM service-linked role.
deletion_task_id
(required)
The deletion task identifier.
For additional information, including details on parameters and properties, see the AWS documentation on Service linked role deletion status.
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.
Syntax
Ensure that a service-linked role deletion task exists.
describe aws_iam_service_linked_role_deletion_status(deletion_task_id: 'DELETION_TASK_ID') do
it { should exist }
end
Parameters
deletion_task_id
(required)The deletion task identifier.
Properties
status
- The status of the deletion. Valid Values:
SUCCEEDED
,IN_PROGRESS
,FAILED
,NOT_STARTED
.
Examples
Ensure a service-linked role is deleted.
describe aws_iam_service_linked_role_deletion_status(deletion_task_id: 'DELETION_TASK_ID') do
its('status') { should eq 'SUCCEEDED' }
end
Matchers
This InSpec audit resource has the following special matchers. For a complete list of available matchers, please visit our Universal Matchers page.
exist
Use should
to test that the entity exists.
describe aws_iam_service_linked_role_deletion_status(deletion_task_id: 'DELETION_TASK_ID') do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_iam_service_linked_role_deletion_status(deletion_task_id: 'DELETION_TASK_ID') do
it { should_not exist }
end
be_available
Use should
to check if the Service Linked Role deletion task is available.
describe aws_iam_service_linked_role_deletion_status(deletion_task_id: 'DELETION_TASK_ID') do
it { should be_available }
end
AWS Permissions
Your Principal will need the IAM:Client:GetServiceLinkedRoleDeletionStatusResponse
action with Effect
set to Allow
.