Interface TaskStateBaseProps
- All Superinterfaces:
AssignableStateOptions
,software.amazon.jsii.JsiiSerializable
,JsonataCommonOptions
,JsonPathCommonOptions
,StateBaseProps
,TaskStateBaseOptions
- All Known Subinterfaces:
AthenaGetQueryExecutionProps
,AthenaGetQueryResultsProps
,AthenaStartQueryExecutionProps
,AthenaStopQueryExecutionProps
,BatchSubmitJobProps
,BedrockInvokeModelProps
,CallApiGatewayEndpointBaseProps
,CallApiGatewayHttpApiEndpointProps
,CallApiGatewayRestApiEndpointProps
,CallAwsServiceCrossRegionProps
,CallAwsServiceProps
,CodeBuildStartBuildBatchProps
,CodeBuildStartBuildProps
,DynamoDeleteItemProps
,DynamoGetItemProps
,DynamoPutItemProps
,DynamoUpdateItemProps
,EcsRunTaskProps
,EksCallProps
,EmrAddStepProps
,EmrCancelStepProps
,EmrContainersCreateVirtualClusterProps
,EmrContainersDeleteVirtualClusterProps
,EmrContainersStartJobRunProps
,EmrCreateClusterProps
,EmrModifyInstanceFleetByNameProps
,EmrModifyInstanceGroupByNameProps
,EmrSetClusterTerminationProtectionProps
,EmrTerminateClusterProps
,EvaluateExpressionProps
,EventBridgePutEventsProps
,EventBridgeSchedulerCreateScheduleTaskProps
,GlueDataBrewStartJobRunProps
,GlueStartCrawlerRunProps
,GlueStartJobRunProps
,HttpInvokeProps
,LambdaInvokeProps
,MediaConvertCreateJobProps
,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
,CallAwsServiceCrossRegionProps.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
,EventBridgeSchedulerCreateScheduleTaskProps.Jsii$Proxy
,GlueDataBrewStartJobRunProps.Jsii$Proxy
,GlueStartCrawlerRunProps.Jsii$Proxy
,GlueStartJobRunProps.Jsii$Proxy
,HttpInvokeProps.Jsii$Proxy
,LambdaInvokeProps.Jsii$Proxy
,MediaConvertCreateJobProps.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.109.0 (build c221850)",
date="2025-03-19T18:01:43.211Z")
@Stability(Stable)
public interface TaskStateBaseProps
extends software.amazon.jsii.JsiiSerializable, StateBaseProps, TaskStateBaseOptions, AssignableStateOptions, JsonPathCommonOptions, JsonataCommonOptions
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 assign; Object outputs; Object resultSelector; TaskRole taskRole; Timeout timeout; TaskStateBaseProps taskStateBaseProps = TaskStateBaseProps.builder() .assign(Map.of( "assignKey", assign)) .comment("comment") .credentials(Credentials.builder() .role(taskRole) .build()) .heartbeat(Duration.minutes(30)) .heartbeatTimeout(timeout) .inputPath("inputPath") .integrationPattern(IntegrationPattern.REQUEST_RESPONSE) .outputPath("outputPath") .outputs(outputs) .queryLanguage(QueryLanguage.JSON_PATH) .resultPath("resultPath") .resultSelector(Map.of( "resultSelectorKey", resultSelector)) .stateName("stateName") .taskTimeout(timeout) .timeout(Duration.minutes(30)) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forTaskStateBaseProps
static final class
An implementation forTaskStateBaseProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic TaskStateBaseProps.Builder
builder()
default String
JSONPath expression to indicate where to inject the state's output.The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssign
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions
getOutputs
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions
getInputPath, getOutputPath
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateName
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions
getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeout
-
Method Details
-
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: $
-
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:
-
builder
- Returns:
- a
TaskStateBaseProps.Builder
ofTaskStateBaseProps
-