TaskStateBaseProps

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.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:53.869Z")
public interface TaskStateBaseProps
```
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.services.stepfunctions.*;
 import software.amazon.awscdk.core.*;
 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

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static TaskStateBaseProps.Builder`	`builder()`
`default java.lang.String`	`getComment()` An optional description for this state.
`default Duration`	`getHeartbeat()` Timeout for the heartbeat.
`default java.lang.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 java.lang.String`	`getOutputPath()` JSONPath expression to select select a portion of the state output to pass to the next state.
`default java.lang.String`	`getResultPath()` JSONPath expression to indicate where to inject the state's output.
`default java.util.Map<java.lang.String,java.lang.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.

- Method Detail
  - getComment
```
default java.lang.String getComment()
```
    An optional description for this state.
    Default: - No comment
  - getHeartbeat
```
default Duration getHeartbeat()
```
    Timeout for the heartbeat.
    Default: - None
  - getInputPath
```
default java.lang.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
```
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
```
default java.lang.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
```
default java.lang.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
```
default java.util.Map<java.lang.String,java.lang.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
```
default Duration getTimeout()
```
    Timeout for the state machine.
    Default: - None
  - builder
```
static TaskStateBaseProps.Builder builder()
```
    Returns:
    
    a TaskStateBaseProps.Builder of TaskStateBaseProps

Interface TaskStateBaseProps

Nested Class Summary

Method Summary

Method Detail

getComment

getHeartbeat

getInputPath

getIntegrationPattern

getOutputPath

getResultPath

getResultSelector

getTimeout

builder