Namespace Amazon.CDK.AWS.StepFunctions

Classes

Activity	Define a new Step Functions Activity.
ActivityProps	Properties for defining a new Step Functions Activity.
AfterwardsOptions	Options for selecting the choice paths.
AssignableStateOptions	Option properties for state that can assign variables.
AwsOwnedEncryptionConfiguration	Define a new AwsOwnedEncryptionConfiguration.
CatchProps	Error handler details.
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 .
CfnActivity.EncryptionConfigurationProperty	Settings to configure server-side encryption for an activity.
CfnActivity.TagsEntryProperty	The TagsEntry property specifies tags to identify an activity.
CfnActivityProps	Properties for defining a CfnActivity.
CfnStateMachine	Provisions a state machine.
CfnStateMachine.CloudWatchLogsLogGroupProperty	Defines a CloudWatch log group.
CfnStateMachine.EncryptionConfigurationProperty	Settings to configure server-side encryption for a state machine.
CfnStateMachine.LogDestinationProperty	Defines a destination for LoggingConfiguration .
CfnStateMachine.LoggingConfigurationProperty	Defines what execution history events are logged and where they are logged.
CfnStateMachine.S3LocationProperty	Defines the S3 bucket location where a state machine definition is stored.
CfnStateMachine.TagsEntryProperty	The TagsEntry property specifies tags to identify a state machine.
CfnStateMachine.TracingConfigurationProperty	Selects whether or not the state machine's AWS X-Ray tracing is enabled.
CfnStateMachineAlias	Represents a state machine alias . An alias routes traffic to one or two versions of the same state machine.
CfnStateMachineAlias.DeploymentPreferenceProperty	Enables gradual state machine deployments.
CfnStateMachineAlias.RoutingConfigurationVersionProperty	The state machine version to which you want to route the execution traffic.
CfnStateMachineAliasProps	Properties for defining a CfnStateMachineAlias.
CfnStateMachineProps	Properties for defining a CfnStateMachine.
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	Properties for defining a CfnStateMachineVersion.
Chain	A collection of states to chain onto.
ChainDefinitionBody
Choice	Define a Choice in the state machine.
ChoiceJsonPathProps	Properties for defining a Choice state that using JSONPath.
ChoiceJsonataProps	Properties for defining a Choice state that using JSONata.
ChoiceProps	Properties for defining a Choice state.
ChoiceTransitionOptions	Options for Choice Transition.
Condition	A Condition for use in a Choice state branch.
Credentials	Specifies a target role assumed by the State Machine's execution role for invoking the task's resource.
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	Properties for defining a custom state definition.
CustomerManagedEncryptionConfiguration	Define a new CustomerManagedEncryptionConfiguration.
DefinitionBody
DefinitionConfig	Partial object from the StateMachine L1 construct properties containing definition information.
DistributedMap	Define a Distributed Mode Map state in the state machine.
DistributedMapJsonPathProps	Properties for configuring a Distribute Map state that using JSONPath.
DistributedMapJsonataProps	Properties for configuring a Distribute Map state that using JSONata.
DistributedMapProps	Properties for configuring a Distribute Map state.
EncryptionConfiguration	Base class for creating an EncryptionConfiguration for either state machines or activities.
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.
FailJsonPathProps	Properties for defining a Fail state that using JSONPath.
FailJsonataProps	Properties for defining a Fail state that using JSONata.
FailProps	Properties for defining a Fail state.
FieldUtils	Helper functions to work with structures containing fields.
FileDefinitionBody
FindStateOptions	Options for finding reachable states.
ItemBatcher	Configuration for processing a group of items in a single child workflow execution.
ItemBatcherProps	Interface for ItemBatcher configuration properties.
ItemReaderProps	Base interface for Item Reader configuration properties.
JsonPath	Extract a field from the State Machine data or context that gets passed around between states.
JsonPathCommonOptions	Option properties for JSONPath state.
JsonPathStateProps	Properties shared by all states that use JSONPath.
JsonataCommonOptions	Option properties for JSONata state.
JsonataStateOptions	Option properties for JSONata task state.
JsonataStateProps	Properties shared by all states that use JSONata.
LogOptions	Defines what execution history events are logged and where they are logged.
Map	Define a Map state in the state machine.
MapBase	Define a Map state in the state machine.
MapBaseJsonPathOptions	Base properties for defining a Map state that using JSONPath.
MapBaseJsonataOptions	Base properties for defining a Map state that using JSONata.
MapBaseOptions	Base properties for defining a Map state.
MapBaseProps	Properties for defining a Map state.
MapJsonPathProps	Properties for defining a Map state that using JSONPath.
MapJsonataProps	Properties for defining a Map state that using JSONata.
MapProps	Properties for defining a Map state.
Parallel	Define a Parallel state in the state machine.
ParallelJsonPathProps	Properties for defining a Parallel state that using JSONPath.
ParallelJsonataProps	Properties for defining a Parallel state that using JSONata.
ParallelProps	Properties for defining a Parallel state.
Pass	Define a Pass in the state machine.
PassJsonPathProps	Properties for defining a Pass state that using JSONPath.
PassJsonataProps	Properties for defining a Pass state that using JSONata.
PassProps	Properties for defining a Pass state.
ProcessorConfig	Specifies the configuration for the processor Map state.
ProvideItems	The array that the Map state will iterate over.
Result	The result of a Pass operation.
ResultWriter	(deprecated) Configuration for writing Distributed Map state results to S3.
ResultWriterProps	(deprecated) Interface for Result Writer configuration props.
ResultWriterV2	Configuration for writing Distributed Map state results to S3 The ResultWriter field cannot be empty.
ResultWriterV2Props	Interface for Result Writer configuration props.
RetryProps	Retry details.
S3CsvItemReader	Item Reader configuration for iterating over items in a CSV file stored in S3.
S3CsvItemReaderProps	Properties for configuring an Item Reader that iterates over items in a CSV file in S3.
S3FileItemReaderProps	Base interface for Item Reader configuration properties the iterate over entries in a S3 file.
S3JsonItemReader	Item Reader configuration for iterating over items in a JSON array stored in a S3 file.
S3JsonLItemReader	Item Reader configuration for iterating over the rows of the JSONL file stored in S3.
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	Properties for configuring an Item Reader that iterates over objects in an S3 bucket.
SingleStateOptions	Options for creating a single state.
State	Base class for all other state classes.
StateBaseProps	Properties shared by all states.
StateGraph	A collection of connected states.
StateMachine	Define a StepFunctions State Machine.
StateMachineFragment	Base class for reusable state machine fragments.
StateMachineProps	Properties for defining a State Machine.
StateProps	Properties shared by all states.
StateTransitionMetric	Metrics on the rate limiting performed on state machine execution.
StringDefinitionBody
Succeed	Define a Succeed state in the state machine.
SucceedJsonPathProps	Properties for defining a Succeed state that using JSONPath.
SucceedJsonataProps	Properties for defining a Succeed state that using JSONata.
SucceedProps	Properties for defining a Succeed state.
TaskInput	Type union for task classes that accept multiple types of payload.
TaskMetricsConfig	Task Metrics.
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.
TaskStateBaseOptions	Base options for all task states.
TaskStateBaseProps	Props that are common to all tasks.
TaskStateJsonPathBaseProps	Props that are common to all tasks that using JSONPath.
TaskStateJsonataBaseProps	Props that are common to all tasks that using JSONata.
Timeout	Timeout for a task or heartbeat.
Wait	Define a Wait state in the state machine.
WaitJsonPathProps	Properties for defining a Wait state that using JSONPath.
WaitJsonataProps	Properties for defining a Wait state that using JSONata.
WaitProps	Properties for defining a Wait state.
WaitTime	Represents the Wait state which delays a state machine from continuing for a specified time.
WriterConfig	Configuration to format the output.
WriterConfigProps	Interface for Writer Config props.

Interfaces

CfnActivity.IEncryptionConfigurationProperty	Settings to configure server-side encryption for an activity.
CfnActivity.ITagsEntryProperty	The TagsEntry property specifies tags to identify an activity.
CfnStateMachine.ICloudWatchLogsLogGroupProperty	Defines a CloudWatch log group.
CfnStateMachine.IEncryptionConfigurationProperty	Settings to configure server-side encryption for a state machine.
CfnStateMachine.ILogDestinationProperty	Defines a destination for LoggingConfiguration .
CfnStateMachine.ILoggingConfigurationProperty	Defines what execution history events are logged and where they are logged.
CfnStateMachine.IS3LocationProperty	Defines the S3 bucket location where a state machine definition is stored.
CfnStateMachine.ITagsEntryProperty	The TagsEntry property specifies tags to identify a state machine.
CfnStateMachine.ITracingConfigurationProperty	Selects whether or not the state machine's AWS X-Ray tracing is enabled.
CfnStateMachineAlias.IDeploymentPreferenceProperty	Enables gradual state machine deployments.
CfnStateMachineAlias.IRoutingConfigurationVersionProperty	The state machine version to which you want to route the execution traffic.
IActivity	Represents a Step Functions Activity https://docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html.
IActivityProps	Properties for defining a new Step Functions Activity.
IAfterwardsOptions	Options for selecting the choice paths.
IAssignableStateOptions	Option properties for state that can assign variables.
ICatchProps	Error handler details.
ICfnActivityProps	Properties for defining a CfnActivity.
ICfnStateMachineAliasProps	Properties for defining a CfnStateMachineAlias.
ICfnStateMachineProps	Properties for defining a CfnStateMachine.
ICfnStateMachineVersionProps	Properties for defining a CfnStateMachineVersion.
IChainable	Interface for objects that can be used in a Chain.
IChoiceJsonPathProps	Properties for defining a Choice state that using JSONPath.
IChoiceJsonataProps	Properties for defining a Choice state that using JSONata.
IChoiceProps	Properties for defining a Choice state.
IChoiceTransitionOptions	Options for Choice Transition.
ICredentials	Specifies a target role assumed by the State Machine's execution role for invoking the task's resource.
ICustomStateProps	Properties for defining a custom state definition.
IDefinitionConfig	Partial object from the StateMachine L1 construct properties containing definition information.
IDistributedMapJsonPathProps	Properties for configuring a Distribute Map state that using JSONPath.
IDistributedMapJsonataProps	Properties for configuring a Distribute Map state that using JSONata.
IDistributedMapProps	Properties for configuring a Distribute Map state.
IFailJsonPathProps	Properties for defining a Fail state that using JSONPath.
IFailJsonataProps	Properties for defining a Fail state that using JSONata.
IFailProps	Properties for defining a Fail state.
IFindStateOptions	Options for finding reachable states.
IItemBatcherProps	Interface for ItemBatcher configuration properties.
IItemReader	Base interface for Item Reader configurations.
IItemReaderProps	Base interface for Item Reader configuration properties.
IJsonPathCommonOptions	Option properties for JSONPath state.
IJsonPathStateProps	Properties shared by all states that use JSONPath.
IJsonataCommonOptions	Option properties for JSONata state.
IJsonataStateOptions	Option properties for JSONata task state.
IJsonataStateProps	Properties shared by all states that use JSONata.
ILogOptions	Defines what execution history events are logged and where they are logged.
IMapBaseJsonPathOptions	Base properties for defining a Map state that using JSONPath.
IMapBaseJsonataOptions	Base properties for defining a Map state that using JSONata.
IMapBaseOptions	Base properties for defining a Map state.
IMapBaseProps	Properties for defining a Map state.
IMapJsonPathProps	Properties for defining a Map state that using JSONPath.
IMapJsonataProps	Properties for defining a Map state that using JSONata.
IMapProps	Properties for defining a Map state.
INextable	Interface for states that can have 'next' states.
IParallelJsonPathProps	Properties for defining a Parallel state that using JSONPath.
IParallelJsonataProps	Properties for defining a Parallel state that using JSONata.
IParallelProps	Properties for defining a Parallel state.
IPassJsonPathProps	Properties for defining a Pass state that using JSONPath.
IPassJsonataProps	Properties for defining a Pass state that using JSONata.
IPassProps	Properties for defining a Pass state.
IProcessorConfig	Specifies the configuration for the processor Map state.
IResultWriterProps	(deprecated) Interface for Result Writer configuration props.
IResultWriterV2Props	Interface for Result Writer configuration props.
IRetryProps	Retry details.
IS3CsvItemReaderProps	Properties for configuring an Item Reader that iterates over items in a CSV file in S3.
IS3FileItemReaderProps	Base interface for Item Reader configuration properties the iterate over entries in a S3 file.
IS3ObjectsItemReaderProps	Properties for configuring an Item Reader that iterates over objects in an S3 bucket.
ISingleStateOptions	Options for creating a single state.
IStateBaseProps	Properties shared by all states.
IStateMachine	A State Machine.
IStateMachineProps	Properties for defining a State Machine.
IStateProps	Properties shared by all states.
ISucceedJsonPathProps	Properties for defining a Succeed state that using JSONPath.
ISucceedJsonataProps	Properties for defining a Succeed state that using JSONata.
ISucceedProps	Properties for defining a Succeed state.
ITaskMetricsConfig	Task Metrics.
ITaskStateBaseOptions	Base options for all task states.
ITaskStateBaseProps	Props that are common to all tasks.
ITaskStateJsonPathBaseProps	Props that are common to all tasks that using JSONPath.
ITaskStateJsonataBaseProps	Props that are common to all tasks that using JSONata.
IWaitJsonPathProps	Properties for defining a Wait state that using JSONPath.
IWaitJsonataProps	Properties for defining a Wait state that using JSONata.
IWaitProps	Properties for defining a Wait state.
IWriterConfigProps	Interface for Writer Config props.

Enums

CsvDelimiter	Delimiter used in CSV file.
CsvHeaderLocation	CSV header location options.
InputType	The type of task input.
IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
JitterType	Values allowed in the retrier JitterStrategy field.
LogLevel	Defines which category of execution history events are logged.
OutputType	The format of the Output of the child workflow executions.
ProcessorMode	Mode of the Map workflow.
ProcessorType	Execution type for the Map workflow.
QueryLanguage	The name of the query language used by the state machine or state.
ServiceIntegrationPattern	Three ways to call an integrated service: Request Response, Run a Job and Wait for a Callback with Task Token.
StateMachineType	Two types of state machines are available in AWS Step Functions: EXPRESS AND STANDARD.
Transformation	The transformation to be applied to the Output of the Child Workflow executions.