aws_cdk.aws_stepfunctions

Package Overview

Activity

Define a new Step Functions Activity.

ActivityProps

AfterwardsOptions

CatchProps

CfnActivity

An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions .

CfnActivityProps

CfnStateMachine

Provisions a state machine.

CfnStateMachineAlias

Represents a state machine alias . An alias routes traffic to one or two versions of the same state machine.

CfnStateMachineAliasProps

CfnStateMachineProps

CfnStateMachineVersion

Represents a state machine version . A published version uses the latest state machine *revision* . A revision is an immutable, read-only snapshot of a state machine’s definition and configuration.

CfnStateMachineVersionProps

Chain

A collection of states to chain onto.

ChainDefinitionBody

Choice

Define a Choice in the state machine.

ChoiceProps

ChoiceTransitionOptions

Condition

A Condition for use in a Choice state branch.

Credentials

CsvHeaderLocation

CSV header location options.

CsvHeaders

Configuration for CSV header options for a CSV Item Reader.

CustomState

State defined by supplying Amazon States Language (ASL) in the state machine.

CustomStateProps

DefinitionBody

DefinitionConfig

DistributedMap

Define a Distributed Mode Map state in the state machine.

DistributedMapProps

Errors

Predefined error strings Error names in Amazon States Language - https://states-language.net/spec.html#appendix-a Error handling in Step Functions - https://docs.aws.amazon.com/step-functions/latest/dg/concepts-error-handling.html.

Fail

Define a Fail state in the state machine.

FailProps

FieldUtils

Helper functions to work with structures containing fields.

FileDefinitionBody

FindStateOptions

IActivity

Represents a Step Functions Activity https://docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html.

IChainable

Interface for objects that can be used in a Chain.

IItemReader

Base interface for Item Reader configurations.

INextable

Interface for states that can have ‘next’ states.

IStateMachine

A State Machine.

InputType

The type of task input.

IntegrationPattern

AWS Step Functions integrates with services directly in the Amazon States Language.

ItemBatcher

Configuration for processing a group of items in a single child workflow execution.

ItemBatcherProps

ItemReaderProps

JitterType

Values allowed in the retrier JitterStrategy field.

JsonPath

Extract a field from the State Machine data or context that gets passed around between states.

LogLevel

Defines which category of execution history events are logged.

LogOptions

Map

Define a Map state in the state machine.

MapBase

Define a Map state in the state machine.

MapBaseProps

MapProps

Parallel

Define a Parallel state in the state machine.

ParallelProps

Pass

Define a Pass in the state machine.

PassProps

ProcessorConfig

ProcessorMode

Mode of the Map workflow.

ProcessorType

Execution type for the Map workflow.

Result

The result of a Pass operation.

ResultWriter

Configuration for writing Distributed Map state results to S3.

ResultWriterProps

RetryProps

S3CsvItemReader

Item Reader configuration for iterating over items in a CSV file stored in S3.

S3CsvItemReaderProps

S3FileItemReaderProps

S3JsonItemReader

Item Reader configuration for iterating over items in a JSON array stored in a S3 file.

S3ManifestItemReader

Item Reader configuration for iterating over items in a S3 inventory manifest file stored in S3.

S3ObjectsItemReader

Item Reader configuration for iterating over objects in an S3 bucket.

S3ObjectsItemReaderProps

ServiceIntegrationPattern

Three ways to call an integrated service: Request Response, Run a Job and Wait for a Callback with Task Token.

SingleStateOptions

State

Base class for all other state classes.

StateGraph

A collection of connected states.

StateMachine

Define a StepFunctions State Machine.

StateMachineFragment

Base class for reusable state machine fragments.

StateMachineProps

StateMachineType

Two types of state machines are available in AWS Step Functions: EXPRESS AND STANDARD.

StateProps

StateTransitionMetric

Metrics on the rate limiting performed on state machine execution.

StringDefinitionBody

Succeed

Define a Succeed state in the state machine.

SucceedProps

TaskInput

Type union for task classes that accept multiple types of payload.

TaskMetricsConfig

TaskRole

Role to be assumed by the State Machine’s execution role for invoking a task’s resource.

TaskStateBase

Define a Task state in the state machine.

TaskStateBaseProps

Timeout

Timeout for a task or heartbeat.

Wait

Define a Wait state in the state machine.

WaitProps

WaitTime

Represents the Wait state which delays a state machine from continuing for a specified time.