software.amazon.awscdk.services.stepfunctions

Interface TaskStateBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AthenaGetQueryExecutionProps, AthenaGetQueryResultsProps, AthenaStartQueryExecutionProps, AthenaStopQueryExecutionProps, BatchSubmitJobProps, CallApiGatewayEndpointBaseProps, CallApiGatewayHttpApiEndpointProps, CallApiGatewayRestApiEndpointProps, CallAwsServiceProps, CodeBuildStartBuildProps, DynamoDeleteItemProps, DynamoGetItemProps, DynamoPutItemProps, DynamoUpdateItemProps, EcsRunTaskProps, EksCallProps, EmrAddStepProps, EmrCancelStepProps, EmrContainersCreateVirtualClusterProps, EmrContainersDeleteVirtualClusterProps, EmrContainersStartJobRunProps, EmrCreateClusterProps, EmrModifyInstanceFleetByNameProps, EmrModifyInstanceGroupByNameProps, EmrSetClusterTerminationProtectionProps, EmrTerminateClusterProps, EvaluateExpressionProps, EventBridgePutEventsProps, GlueDataBrewStartJobRunProps, GlueStartJobRunProps, 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, CallApiGatewayEndpointBaseProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointProps.Jsii$Proxy, CallApiGatewayRestApiEndpointProps.Jsii$Proxy, CallAwsServiceProps.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, GlueStartJobRunProps.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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.409Z")
 @Stability(value=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;
 TaskStateBaseProps taskStateBaseProps = TaskStateBaseProps.builder()
         .comment("comment")
         .heartbeat(Duration.minutes(30))
         .inputPath("inputPath")
         .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
         .outputPath("outputPath")
         .resultPath("resultPath")
         .resultSelector(Map.of(
                 "resultSelectorKey", resultSelector))
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TaskStateBaseProps.Builder	builder()
default String	getComment() An optional description for this state.
default Duration	getHeartbeat() Timeout for the heartbeat.
default String	getInputPath() JSONPath expression to select part of the state to be the input to this state.
default IntegrationPattern	getIntegrationPattern() AWS Step Functions integrates with services directly in the Amazon States Language.
default String	getOutputPath() JSONPath expression to select select a portion of the state output to pass to the next state.
default String	getResultPath() JSONPath expression to indicate where to inject the state's output.
default Map<String,Object>	getResultSelector() The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
default Duration	getTimeout() Timeout for the state machine.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getComment

@Stability(value=Stable)
 @Nullable
default String getComment()

An optional description for this state.

Default: - No comment

getHeartbeat

@Stability(value=Stable)
 @Nullable
default Duration getHeartbeat()

Timeout for the heartbeat.

Default: - None

getInputPath

@Stability(value=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(value=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

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

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

getOutputPath

@Stability(value=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(value=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(value=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:

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

getTimeout

@Stability(value=Stable)
 @Nullable
default Duration getTimeout()

Timeout for the state machine.

Default: - None

builder

@Stability(value=Stable)
static TaskStateBaseProps.Builder builder()

Returns:

a TaskStateBaseProps.Builder of TaskStateBaseProps