Package software.amazon.awscdk.services.stepfunctions

Interface TaskStateBaseProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
AthenaGetQueryExecutionProps, AthenaGetQueryResultsProps, AthenaStartQueryExecutionProps, AthenaStopQueryExecutionProps, BatchSubmitJobProps, BedrockInvokeModelProps, CallApiGatewayEndpointBaseProps, CallApiGatewayHttpApiEndpointProps, CallApiGatewayRestApiEndpointProps, CallAwsServiceProps, CodeBuildStartBuildBatchProps, CodeBuildStartBuildProps, DynamoDeleteItemProps, DynamoGetItemProps, DynamoPutItemProps, DynamoUpdateItemProps, EcsRunTaskProps, EksCallProps, EmrAddStepProps, EmrCancelStepProps, EmrContainersCreateVirtualClusterProps, EmrContainersDeleteVirtualClusterProps, EmrContainersStartJobRunProps, EmrCreateClusterProps, EmrModifyInstanceFleetByNameProps, EmrModifyInstanceGroupByNameProps, EmrSetClusterTerminationProtectionProps, EmrTerminateClusterProps, EvaluateExpressionProps, EventBridgePutEventsProps, GlueDataBrewStartJobRunProps, GlueStartCrawlerRunProps, GlueStartJobRunProps, HttpInvokeProps, LambdaInvokeProps, SageMakerCreateEndpointConfigProps, SageMakerCreateEndpointProps, SageMakerCreateModelProps, SageMakerCreateTrainingJobProps, SageMakerCreateTransformJobProps, SageMakerUpdateEndpointProps, SnsPublishProps, SqsSendMessageProps, StepFunctionsInvokeActivityProps, StepFunctionsStartExecutionProps
All Known Implementing Classes:
AthenaGetQueryExecutionProps.Jsii$Proxy, AthenaGetQueryResultsProps.Jsii$Proxy, AthenaStartQueryExecutionProps.Jsii$Proxy, AthenaStopQueryExecutionProps.Jsii$Proxy, BatchSubmitJobProps.Jsii$Proxy, BedrockInvokeModelProps.Jsii$Proxy, CallApiGatewayEndpointBaseProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointProps.Jsii$Proxy, CallApiGatewayRestApiEndpointProps.Jsii$Proxy, CallAwsServiceProps.Jsii$Proxy, CodeBuildStartBuildBatchProps.Jsii$Proxy, CodeBuildStartBuildProps.Jsii$Proxy, DynamoDeleteItemProps.Jsii$Proxy, DynamoGetItemProps.Jsii$Proxy, DynamoPutItemProps.Jsii$Proxy, DynamoUpdateItemProps.Jsii$Proxy, EcsRunTaskProps.Jsii$Proxy, EksCallProps.Jsii$Proxy, EmrAddStepProps.Jsii$Proxy, EmrCancelStepProps.Jsii$Proxy, EmrContainersCreateVirtualClusterProps.Jsii$Proxy, EmrContainersDeleteVirtualClusterProps.Jsii$Proxy, EmrContainersStartJobRunProps.Jsii$Proxy, EmrCreateClusterProps.Jsii$Proxy, EmrModifyInstanceFleetByNameProps.Jsii$Proxy, EmrModifyInstanceGroupByNameProps.Jsii$Proxy, EmrSetClusterTerminationProtectionProps.Jsii$Proxy, EmrTerminateClusterProps.Jsii$Proxy, EvaluateExpressionProps.Jsii$Proxy, EventBridgePutEventsProps.Jsii$Proxy, GlueDataBrewStartJobRunProps.Jsii$Proxy, GlueStartCrawlerRunProps.Jsii$Proxy, GlueStartJobRunProps.Jsii$Proxy, HttpInvokeProps.Jsii$Proxy, LambdaInvokeProps.Jsii$Proxy, SageMakerCreateEndpointConfigProps.Jsii$Proxy, SageMakerCreateEndpointProps.Jsii$Proxy, SageMakerCreateModelProps.Jsii$Proxy, SageMakerCreateTrainingJobProps.Jsii$Proxy, SageMakerCreateTransformJobProps.Jsii$Proxy, SageMakerUpdateEndpointProps.Jsii$Proxy, SnsPublishProps.Jsii$Proxy, SqsSendMessageProps.Jsii$Proxy, StepFunctionsInvokeActivityProps.Jsii$Proxy, StepFunctionsStartExecutionProps.Jsii$Proxy, TaskStateBaseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:25.328Z") @Stability(Stable) public interface TaskStateBaseProps extends software.amazon.jsii.JsiiSerializable
Props that are common to all tasks.

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.*;
 Object resultSelector;
 TaskRole taskRole;
 Timeout timeout;
 TaskStateBaseProps taskStateBaseProps = TaskStateBaseProps.builder()
         .comment("comment")
         .credentials(Credentials.builder()
                 .role(taskRole)
                 .build())
         .heartbeat(Duration.minutes(30))
         .heartbeatTimeout(timeout)
         .inputPath("inputPath")
         .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
         .outputPath("outputPath")
         .resultPath("resultPath")
         .resultSelector(Map.of(
                 "resultSelectorKey", resultSelector))
         .stateName("stateName")
         .taskTimeout(timeout)
         .timeout(Duration.minutes(30))
         .build();

  • Method Details

    • getComment

      @Stability(Stable) @Nullable default String getComment()
      An optional description for this state.

      Default: - No comment

    • getCredentials

      @Stability(Stable) @Nullable default Credentials getCredentials()
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      See Also:

    • getHeartbeat

      @Stability(Deprecated) @Deprecated @Nullable default Duration getHeartbeat()
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

    • getHeartbeatTimeout

      @Stability(Stable) @Nullable default Timeout getHeartbeatTimeout()
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

    • getInputPath

      @Stability(Stable) @Nullable default String getInputPath()
      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 {}.

      Default: - The entire task input (JSON path '$')

    • getIntegrationPattern

      @Stability(Stable) @Nullable default IntegrationPattern getIntegrationPattern()
      AWS Step Functions integrates with services directly in the Amazon States Language.

      You can control these AWS services using service integration patterns.

      Depending on the AWS Service, the Service Integration Pattern availability will vary.

      Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

      See Also:

    • getOutputPath

      @Stability(Stable) @Nullable default String getOutputPath()
      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 {}.

      Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')

    • getResultPath

      @Stability(Stable) @Nullable default String getResultPath()
      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.

      Default: - Replaces the entire input with the result (JSON path '$')

    • getResultSelector

      @Stability(Stable) @Nullable default Map<String,Object> getResultSelector()
      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.

      Default: - None

      See Also:

    • getStateName

      @Stability(Stable) @Nullable default String getStateName()
      Optional name for this state.

      Default: - The construct ID will be used as state name

    • getTaskTimeout

      @Stability(Stable) @Nullable default Timeout getTaskTimeout()
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

    • getTimeout

      @Stability(Deprecated) @Deprecated @Nullable default Duration getTimeout()
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

    • builder

      @Stability(Stable) static TaskStateBaseProps.Builder builder()
      Returns:
      a TaskStateBaseProps.Builder of TaskStateBaseProps