StepFunctionsInvokeActivityJsonataProps Struct
Properties for invoking an Activity worker using JSONata.
| Source | aws-stepfunctions-tasks/lib/stepfunctions/invoke-activity.ts |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
declare const activity: stepfunctions.Activity;
declare const arguments_: any;
declare const assign: any;
declare const outputs: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const stepFunctionsInvokeActivityJsonataProps: stepfunctions_tasks.StepFunctionsInvokeActivityJsonataProps = {
activity: activity,
// the properties below are optional
arguments: arguments_,
assign: {
assignKey: assign,
},
comment: 'comment',
credentials: {
role: taskRole,
},
heartbeat: cdk.Duration.minutes(30),
heartbeatTimeout: timeout,
integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
outputs: outputs,
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
stateName: 'stateName',
taskTimeout: timeout,
timeout: cdk.Duration.minutes(30),
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
# activity: stepfunctions.Activity
# arguments_: Any
# assign: Any
# outputs: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout
step_functions_invoke_activity_jsonata_props = stepfunctions_tasks.StepFunctionsInvokeActivityJsonataProps(
activity=activity,
# the properties below are optional
arguments=arguments_,
assign={
"assign_key": assign
},
comment="comment",
credentials=stepfunctions.Credentials(
role=task_role
),
heartbeat=cdk.Duration.minutes(30),
heartbeat_timeout=timeout,
integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
outputs=outputs,
query_language=stepfunctions.QueryLanguage.JSON_PATH,
state_name="stateName",
task_timeout=timeout,
timeout=cdk.Duration.minutes(30)
)
// 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();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
Activity activity;
var arguments_;
var assign;
var outputs;
TaskRole taskRole;
Timeout timeout;
var stepFunctionsInvokeActivityJsonataProps = new StepFunctionsInvokeActivityJsonataProps {
Activity = activity,
// the properties below are optional
Arguments = arguments_,
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Comment = "comment",
Credentials = new Credentials {
Role = taskRole
},
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
Outputs = outputs,
QueryLanguage = QueryLanguage.JSON_PATH,
StateName = "stateName",
TaskTimeout = timeout,
Timeout = Duration.Minutes(30)
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var activity Activity
var arguments_ interface{}
var assign interface{}
var outputs interface{}
var taskRole TaskRole
var timeout Timeout
stepFunctionsInvokeActivityJsonataProps := &StepFunctionsInvokeActivityJsonataProps{
Activity: activity,
// the properties below are optional
Arguments: arguments_,
Assign: map[string]interface{}{
"assignKey": assign,
},
Comment: jsii.String("comment"),
Credentials: &Credentials{
Role: taskRole,
},
Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
HeartbeatTimeout: timeout,
IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
Outputs: outputs,
QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
StateName: jsii.String("stateName"),
TaskTimeout: timeout,
Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
}
Properties
argumentsoptionalanyargumentsoptionalAnyargumentsoptionalObjectArgumentsoptionalobjectArgumentsoptionalinterface{} #Default: No arguments
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{} #Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #Default: No comment
credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials #Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration = None deprecated #heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern #Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{} #Default: $states.result or $states.errorOutput
notes
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.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage = JSONPath #If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #Default: The construct ID will be used as state name