Module library

Step Functions

Terraform module to create AWS Step Functions

Inputs

40 / 42
attach_cloudwatch_logs_policyoptionalbool

Controls whether CloudWatch Logs policy should be added to IAM role for Lambda Function

Defaulttrue
attach_policiesoptionalbool

Controls whether list of policies should be added to IAM role

Defaultfalse
attach_policies_for_integrationsoptionalbool

Whether to attach AWS Service policies to IAM role

Defaulttrue
attach_policyoptionalbool

Controls whether policy should be added to IAM role

Defaultfalse
attach_policy_jsonoptionalbool

Controls whether policy_json should be added to IAM role

Defaultfalse
attach_policy_jsonsoptionalbool

Controls whether policy_jsons should be added to IAM role

Defaultfalse
attach_policy_statementsoptionalbool

Controls whether policy_statements should be added to IAM role

Defaultfalse
aws_region_assume_roleoptionalstring

Name of AWS regions where IAM role can be assumed by the Step Function

Default""
cloudwatch_log_group_kms_key_idoptionalstring

The ARN of the KMS Key to use when encrypting log data.

Defaultnull
cloudwatch_log_group_nameoptionalstring

Name of Cloudwatch Logs group name to use.

Defaultnull
cloudwatch_log_group_retention_in_daysoptionalnumber

Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

Defaultnull
cloudwatch_log_group_tagsoptionalmap(string)

A map of tags to assign to the resource.

Default{}
createoptionalbool

Whether to create Step Function resource

Defaulttrue
create_roleoptionalbool

Whether to create IAM role for the Step Function

Defaulttrue
definitionoptionalstring

The Amazon States Language definition of the Step Function

Default""
encryption_configurationoptionalany

Defines what encryption configuration is used to encrypt data in the State Machine.

Default{}
logging_configurationoptionalmap(string)

Defines what execution history events are logged and where they are logged

Default{}
nameoptionalstring

The name of the Step Function

Default""
number_of_policiesoptionalnumber

Number of policies to attach to IAM role

Default0
number_of_policy_jsonsoptionalnumber

Number of policies JSON to attach to IAM role

Default0
policiesoptionallist(string)

List of policy statements ARN to attach to IAM role

Default[]
policyoptionalstring

An additional policy document ARN to attach to IAM role

Defaultnull
policy_jsonoptionalstring

An additional policy document as JSON to attach to IAM role

Defaultnull
policy_jsonsoptionallist(string)

List of additional policy documents as JSON to attach to IAM role

Default[]
policy_pathoptionalstring

Path of IAM policies to use for Step Function

Defaultnull
policy_statementsoptionalany

Map of dynamic policy statements to attach to IAM role

Default{}
publishoptionalbool

Determines whether to set a version of the state machine when it is created.

Defaultfalse
regionoptionalstring

Region where the resource(s) will be managed. Defaults to the region set in the provider configuration

Defaultnull
role_arnoptionalstring

The Amazon Resource Name (ARN) of the IAM role to use for this Step Function

Default""
role_descriptionoptionalstring

Description of IAM role to use for Step Function

Defaultnull
role_force_detach_policiesoptionalbool

Specifies to force detaching any policies the IAM role has before destroying it.

Defaulttrue
role_nameoptionalstring

Name of IAM role to use for Step Function

Defaultnull
role_pathoptionalstring

Path of IAM role to use for Step Function

Defaultnull
role_permissions_boundaryoptionalstring

The ARN of the policy that is used to set the permissions boundary for the IAM role used by Step Function

Defaultnull
role_tagsoptionalmap(string)

A map of tags to assign to IAM role

Default{}
service_integrationsoptionalany

Map of AWS service integrations to allow in IAM role policy

Default{}
sfn_state_machine_timeoutsoptionalmap(string)

Create, update, and delete timeout configurations for the step function.

Default{}
tagsoptionalmap(string)

Maps of tags to assign to the Step Function

Default{}
trusted_entitiesoptionallist(string)

Step Function additional trusted entities for assuming roles (trust relationship)

Default[]
typeoptionalstring

Determines whether a Standard or Express state machine is created. The default is STANDARD. Valid Values: STANDARD | EXPRESS

DefaultSTANDARD

All 42 are optional — the module deploys with none of them set. Showing 40, so the site stays a static download — the remaining 2 are in the source.

Outputs

10
cloudwatch_log_group_arn

The ARN of the CloudWatch log group created for the Step Function

cloudwatch_log_group_name

The name of the CloudWatch log group created for the Step Function

role_arn

The ARN of the IAM role created for the Step Function

role_name

The name of the IAM role created for the Step Function

state_machine_arn

The ARN of the Step Function

state_machine_creation_date

The date the Step Function was created

state_machine_id

The ARN of the Step Function

state_machine_name

The Name of the Step Function

state_machine_status

The current status of the Step Function

state_machine_version_arn

The ARN of state machine version

What the agent wires into the next module. An edge on the architecture diagram is one of these consumed by something else.