Module: step-functions
Terraform module to provision AWS Step Functions.
Usage
For a complete example, see examples/complete
For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.
locals {
enabled = module.this.enabled
logging_configuration = {
include_execution_data = true
level = "ALL"
}
# https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html
# https://docs.aws.amazon.com/step-functions/latest/dg/connect-parameters.html
definition = {
"Comment" = "Test Step Function"
"StartAt" = "Hello"
"States" = {
"Hello" = {
"Type" = "Pass"
"Result" = "Hello"
"Next" = "World"
},
"World" = {
"Type" = "Pass"
"Result" = "World"
"Next" = "Send message to SQS"
},
# https://docs.aws.amazon.com/step-functions/latest/dg/connect-sqs.html
"Send message to SQS" = {
"Type" = "Task"
"Resource" = "arn:aws:states:::sqs:sendMessage"
"Parameters" = {
"QueueUrl" = local.enabled ? aws_sqs_queue.default[0].url : ""
"MessageBody" = "Hello World"
}
"Next" = "Publish to SNS"
}
# https://docs.aws.amazon.com/step-functions/latest/dg/connect-sns.html
"Publish to SNS" = {
"Type" = "Task",
"Resource" = "arn:aws:states:::sns:publish"
"Parameters" = {
"TopicArn" = module.sns.sns_topic_arn
"Message" = "Hello World"
}
"End" = true
}
}
}
iam_policies = {
# https://docs.aws.amazon.com/step-functions/latest/dg/sns-iam.html
"SnsAllowPublish" = {
effect = "Allow"
actions = [
"sns:Publish"
]
resources = [
module.sns.sns_topic_arn
]
}
# https://docs.aws.amazon.com/step-functions/latest/dg/sqs-iam.html
"SqsAllowSendMessage" = {
effect = "Allow"
actions = [
"sqs:SendMessage"
]
resources = [
local.enabled ? aws_sqs_queue.default[0].arn : ""
]
}
}
}
module "step_function" {
source = "cloudposse/step-functions/aws"
# Cloud Posse recommends pinning every module to a specific version
version = "x.x.x"
type = "EXPRESS"
tracing_enabled = true
logging_configuration = local.logging_configuration
definition = local.definition
iam_policies = local.iam_policies
context = module.this.context
}
module "sns" {
source = "cloudposse/sns-topic/aws"
version = "0.20.2"
sqs_dlq_enabled = true
fifo_topic = true
fifo_queue_enabled = true
context = module.this.context
}
resource "aws_sqs_queue" "default" {
count = local.enabled ? 1 : 0
name = module.this.id
fifo_queue = false
visibility_timeout_seconds = 30
message_retention_seconds = 86400
max_message_size = 2048
delay_seconds = 90
receive_wait_time_seconds = 10
tags = module.this.tags
}
Requirements
Name | Version |
---|---|
terraform | >= 1.3.0 |
aws | >= 4.0 |
Providers
Name | Version |
---|---|
aws | >= 4.0 |
Modules
Name | Source | Version |
---|---|---|
logs_label | cloudposse/label/null | 0.25.0 |
this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_cloudwatch_log_group.logs | resource |
aws_iam_policy.default | resource |
aws_iam_policy.logs | resource |
aws_iam_policy_attachment.default | resource |
aws_iam_policy_attachment.logs | resource |
aws_iam_role.default | resource |
aws_sfn_state_machine.default | resource |
aws_iam_policy_document.assume_role | data source |
aws_iam_policy_document.default | data source |
aws_iam_policy_document.logs | data source |
aws_region.current | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element. | list(string) | [] | no |
cloudwatch_log_group_kms_key_id | The ARN of the KMS Key to use when encrypting log data | string | null | no |
cloudwatch_log_group_name | Name of Cloudwatch Logs Group to use. If not provided, a name will be generated from the context | string | null | no |
cloudwatch_log_group_retention_in_days | Specifies the number of days to retain log events in the Log Group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653 | number | null | no |
context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. | any |
| no |
definition | The Amazon States Language definition for the Step Function. Refer to https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html for more details | any | n/a | yes |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id .Default is {} (descriptors output will be empty). | any | {} | no |
enabled | Set to false to prevent the module from creating any resources | bool | null | no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
existing_aws_cloudwatch_log_group_arn | The Amazon Resource Name (ARN) of the existing CloudWatch Log Group to use for the Step Function. If not provided, a new CloudWatch Log Group will be created | string | null | no |
existing_iam_role_arn | The Amazon Resource Name (ARN) of the existing IAM role to use for the Step Function. If not provided, a new IAM role will be created | string | null | no |
iam_policies | IAM policies to attach to the created IAM role for the Step Function. The map keys will be used as the policy SIDs |
| {} | no |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0 .Does not affect id_full . | number | null | no |
label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower , title , upper .Default value: title . | string | null | no |
label_order | The order in which the labels (ID elements) appear in the id .Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
label_value_case | Controls the letter case of ID elements (labels) as included in id ,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower , title , upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower . | string | null | no |
labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id , not the name .Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) |
| no |
logging_configuration | Defines what execution history events are logged and where they are logged |
|
| no |
name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag .The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
role_description | Description of the created IAM role | string | null | no |
role_force_detach_policies | Specifies to force detaching any policies the created IAM role has before destroying it | bool | true | no |
role_name | Name of the created IAM role. If not provided, a name will be generated from the context | string | null | no |
role_path | Path of the created IAM role | string | null | no |
role_permissions_boundary | The ARN of the policy that is used to set the permissions boundary for the created IAM role | string | null | no |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
step_function_name | The name of the Step Function. If not provided, a name will be generated from the context | string | null | no |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
tracing_enabled | When set to true, AWS X-Ray tracing is enabled. Make sure the State Machine has the correct IAM policies for logging | bool | false | no |
type | Determines whether a Standard or Express state machine is created. The default is STANDARD. Valid Values: STANDARD, EXPRESS | string | "STANDARD" | no |
Outputs
Name | Description |
---|---|
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 | State machine ARN |
state_machine_creation_date | State machine creation date |
state_machine_id | State machine ID |
state_machine_status | State machine status |