Package software.amazon.awscdk.services.stepfunctions.tasks

Interface StepFunctionsInvokeActivityProps

All Superinterfaces:

AssignableStateOptions, software.amazon.jsii.JsiiSerializable, JsonataCommonOptions, JsonataStateOptions, JsonPathCommonOptions, StateBaseProps, TaskStateBaseOptions, TaskStateBaseProps

All Known Implementing Classes:

StepFunctionsInvokeActivityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:41.669Z")
@Stability(Stable)
public interface StepFunctionsInvokeActivityProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps, JsonataStateOptions

Properties for invoking an Activity worker.

Example:

 Activity submitJobActivity = new Activity(this, "SubmitJob");
 StepFunctionsInvokeActivity.Builder.create(this, "Submit Job")
         .activity(submitJobActivity)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StepFunctionsInvokeActivityProps.Builder	A builder for StepFunctionsInvokeActivityProps
static final class	StepFunctionsInvokeActivityProps.Jsii$Proxy	An implementation for StepFunctionsInvokeActivityProps

Method Summary

Modifier and Type	Method	Description
static StepFunctionsInvokeActivityProps.Builder	builder()
IActivity	getActivity()	Step Functions Activity to invoke.
default Object	getOutputs()	Used to specify and transform output from the state.
default Map<String,Object>	getParameters()	Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions

getAssign

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataStateOptions

getArguments

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions

getInputPath, getOutputPath

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps

getComment, getQueryLanguage, getStateName

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions

getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeout

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getResultPath, getResultSelector

Method Details

getActivity

@Stability(Stable)
@NotNull
IActivity getActivity()

Step Functions Activity to invoke.

getParameters

@Stability(Stable)
@Nullable
default Map<String,Object> getParameters()

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

Default: No parameters

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

getOutputs

@Stability(Stable)
@Nullable
default Object getOutputs()

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

builder

@Stability(Stable)
static StepFunctionsInvokeActivityProps.Builder builder()

Returns:

a StepFunctionsInvokeActivityProps.Builder of StepFunctionsInvokeActivityProps