interface StepFunctionsInvokeActivityProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.StepFunctionsInvokeActivityProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#StepFunctionsInvokeActivityProps |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.StepFunctionsInvokeActivityProps |
![]() | aws_cdk.aws_stepfunctions_tasks.StepFunctionsInvokeActivityProps |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » StepFunctionsInvokeActivityProps |
Properties for invoking an Activity worker.
Example
const submitJobActivity = new sfn.Activity(this, 'SubmitJob');
new tasks.StepFunctionsInvokeActivity(this, 'Submit Job', {
activity: submitJobActivity,
});
Properties
Name | Type | Description |
---|---|---|
activity | IActivity | Step Functions Activity to invoke. |
comment? | string | An optional description for this state. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output | string | JSONPath expression to select select a portion of the state output to pass to the next state. |
parameters? | { [string]: any } | Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
activity
Type:
IActivity
Step Functions Activity to invoke.
comment?
Type:
string
(optional, default: No comment)
An optional description for this state.
credentials?
Type:
Credentials
(optional, default: None (Task is executed using the State Machine's execution role))
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
heartbeat?
⚠️ Deprecated: use heartbeatTimeout
Type:
Duration
(optional, default: None)
Timeout for the heartbeat.
heartbeatTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPath?
Type:
string
(optional, default: The entire task input (JSON path '$'))
JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPattern?
Type:
Integration
(optional, default: IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.)
AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
outputPath?
Type:
string
(optional, default: The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path '$'))
JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
parameters?
Type:
{ [string]: any }
(optional, default: No parameters)
Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
resultPath?
Type:
string
(optional, default: Replaces the entire input with the result (JSON path '$'))
JSONPath expression to indicate where to inject the state's output.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector?
Type:
{ [string]: any }
(optional, default: None)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
taskTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeout?
⚠️ Deprecated: use taskTimeout
Type:
Duration
(optional, default: None)
Timeout for the task.