sudoblark.terraform.module.aws.state_machine

Terraform module to create N number of state machines with custom IAM policies.. - repo managed by sudoblark.terraform.github

Developer documentation

The below documentation is intended to assist a developer with interacting with the Terraform module in order to add, remove or update functionality.

Pre-requisites

• terraform_docs

brew install terraform_docs

• tfenv

git clone https://github.com/tfutils/tfenv.git ~/.tfenv
echo 'export PATH="$HOME/.tfenv/bin:$PATH"' >> ~/.bash_profile

• Virtual environment with pre-commit installed

python3 -m venv venv
source venv/bin/activate
pip install pre-commit

Pre-commit hooks

This repository utilises pre-commit in order to ensure a base level of quality on every commit. The hooks may be installed as follows:

source venv/bin/activate
pip install pre-commit
pre-commit install
pre-commit run --all-files

Module documentation

The below documentation is intended to assist users in utilising the module, the main thing to note is the data structure section which outlines the interface by which users are expected to interact with the module itself, and the examples section which has examples of how to utilise the module.

Requirements

Name	Version
terraform	~> 1.5.0
aws	>= 5.61.0

Providers

Name	Version
aws	5.67.0

Modules

Name	Source	Version
step_function_state_machine	terraform-aws-modules/step-functions/aws	4.2.0

Resources

Name	Type
aws_caller_identity.current_account	data source
aws_iam_policy_document.attached_policies	data source
aws_region.current_region	data source

Inputs

Name	Description	Type	Default	Required
application_name	Name of the application utilising resource.	string	n/a	yes
environment	Which environment this is being instantiated in.	string	n/a	yes
raw_state_machines	Data structure --------------- A list of dictionaries, where each dictionary has the following attributes: REQUIRED --------- - template_file : File path which this machine corresponds to - template_input : A dictionary of key/value pairs, outlining in detail the inputs needed for a template to be instantiated - suffix : Friendly name for the state function - iam_policy_statements : A list of dictionaries where each dictionary is an IAM statement defining glue job permissions -- Each dictionary in this list must define the following attributes: --- sid: Friendly name for the policy, no spaces or special characters allowed --- actions: A list of IAM actions the state machine is allowed to perform --- resources: Which resource(s) the state machine may perform the above actions against --- conditions : An OPTIONAL list of dictionaries, which each defines: ---- test : Test condition for limiting the action ---- variable : Value to test ---- values : A list of strings, denoting what to test for OPTIONAL --------- - cloudwatch_retention : How many days logs should be retained for in Cloudwatch, defaults to 90	list( object({ template_file = string, template_input = map(string), suffix = string, iam_policy_statements = list( object({ sid = string, actions = list(string), resources = list(string), conditions = optional(list( object({ test : string, variable : string, values = list(string) }) ), []) }) ), cloudwatch_retention = optional(number, 90) }) )	n/a	yes

Outputs

No outputs.

Data structure

Data structure
---------------
A list of dictionaries, where each dictionary has the following attributes:

REQUIRED
---------
- template_file         : File path which this machine corresponds to
- template_input        : A dictionary of key/value pairs, outlining in detail the inputs needed for a template to be instantiated
- suffix                : Friendly name for the state function
- iam_policy_statements : A list of dictionaries where each dictionary is an IAM statement defining glue job permissions
-- Each dictionary in this list must define the following attributes:
--- sid: Friendly name for the policy, no spaces or special characters allowed
--- actions: A list of IAM actions the state machine is allowed to perform
--- resources: Which resource(s) the state machine may perform the above actions against
--- conditions    : An OPTIONAL list of dictionaries, which each defines:
---- test         : Test condition for limiting the action
---- variable     : Value to test
---- values       : A list of strings, denoting what to test for


OPTIONAL
---------
- cloudwatch_retention  : How many days logs should be retained for in Cloudwatch, defaults to 90gi

Examples

See examples folder for an example setup.