aws_stepfunctions_activity Resource

[edit on GitHub]

Use the aws_stepfunctions_activity Chef InSpec audit resource to test properties of a single AWS Step Functions activity.

For additional information, including details on parameters and properties, see the AWS documentation on the AWS::StepFunctions::Activity resource.

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

Ensure that the activity exists.

describe aws_stepfunctions_activity(activity_arn: 'ACTIVITY_ARN') do
  it { should exist }
end

Parameters

activity_arn (required)

The Amazon Resource Name (ARN) that identifies the activity.

Properties

activity_arn

The Amazon Resource Name (ARN) that identifies the activity.

name

The name of the activity.

creation_date

The date the activity is created.

Examples

Ensure a activity ARN is available.

describe aws_stepfunctions_activity(activity_arn: 'ACTIVITY_ARN') do
  its('activity_arn') { should eq 'ACTIVITY_ARN' }
end

Ensure an activity name is available.

describe aws_stepfunctions_activity(activity_arn: 'ACTIVITY_ARN') do
  its('name') { should eq 'ACTIVITY_NAME' }
end

Matchers

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

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

exist

Use should to test that the entity exists.

describe aws_stepfunctions_activity(activity_arn: 'ACTIVITY_ARN') do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_stepfunctions_activity(activity_arn: 'ACTIVITY_ARN') do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the States:Client:DescribeActivityOutput action with Effect set to Allow.