Interface StepFunctionsInvokeActivityJsonataProps
- All Superinterfaces:
AssignableStateOptions,software.amazon.jsii.JsiiSerializable,JsonataCommonOptions,JsonataStateOptions,StateBaseProps,TaskStateBaseOptions,TaskStateJsonataBaseProps
- All Known Implementing Classes:
StepFunctionsInvokeActivityJsonataProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
date="2025-12-18T18:20:19.033Z")
@Stability(Stable)
public interface StepFunctionsInvokeActivityJsonataProps
extends software.amazon.jsii.JsiiSerializable, TaskStateJsonataBaseProps, JsonataStateOptions
Properties for invoking an Activity worker using JSONata.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
Activity activity;
Object arguments_;
Object assign;
Object outputs;
TaskRole taskRole;
Timeout timeout;
StepFunctionsInvokeActivityJsonataProps stepFunctionsInvokeActivityJsonataProps = StepFunctionsInvokeActivityJsonataProps.builder()
.activity(activity)
// the properties below are optional
.arguments(arguments_)
.assign(Map.of(
"assignKey", assign))
.comment("comment")
.credentials(Credentials.builder()
.role(taskRole)
.build())
.heartbeat(Duration.minutes(30))
.heartbeatTimeout(timeout)
.integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
.outputs(outputs)
.queryLanguage(QueryLanguage.JSON_PATH)
.stateName("stateName")
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forStepFunctionsInvokeActivityJsonataPropsstatic final classAn implementation forStepFunctionsInvokeActivityJsonataProps -
Method Summary
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssignMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataStateOptions
getArgumentsMethods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateNameMethods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions
getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeout
-
Method Details
-
getActivity
Step Functions Activity to invoke. -
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:
getOutputsin interfaceJsonataCommonOptions- See Also:
-
builder
-