Interface TaskStateJsonPathBaseProps
- All Superinterfaces:
AssignableStateOptions,software.amazon.jsii.JsiiSerializable,JsonPathCommonOptions,StateBaseProps,TaskStateBaseOptions
- All Known Subinterfaces:
AthenaGetQueryExecutionJsonPathProps,AthenaGetQueryResultsJsonPathProps,AthenaStartQueryExecutionJsonPathProps,AthenaStopQueryExecutionJsonPathProps,BatchSubmitJobJsonPathProps,BedrockInvokeModelJsonPathProps,CallApiGatewayEndpointJsonPathBaseProps,CallApiGatewayHttpApiEndpointJsonPathProps,CallApiGatewayRestApiEndpointJsonPathProps,CallAwsServiceCrossRegionJsonPathProps,CallAwsServiceJsonPathProps,CodeBuildStartBuildBatchJsonPathProps,CodeBuildStartBuildJsonPathProps,DynamoDeleteItemJsonPathProps,DynamoGetItemJsonPathProps,DynamoPutItemJsonPathProps,DynamoUpdateItemJsonPathProps,EcsRunTaskJsonPathProps,EksCallJsonPathProps,EmrAddStepJsonPathProps,EmrCancelStepJsonPathProps,EmrContainersCreateVirtualClusterJsonPathProps,EmrContainersDeleteVirtualClusterJsonPathProps,EmrContainersStartJobRunJsonPathProps,EmrCreateClusterJsonPathProps,EmrModifyInstanceFleetByNameJsonPathProps,EmrModifyInstanceGroupByNameJsonPathProps,EmrSetClusterTerminationProtectionJsonPathProps,EmrTerminateClusterJsonPathProps,EventBridgePutEventsJsonPathProps,EventBridgeSchedulerCreateScheduleTaskJsonPathProps,GlueDataBrewStartJobRunJsonPathProps,GlueStartCrawlerRunJsonPathProps,GlueStartJobRunJsonPathProps,HttpInvokeJsonPathProps,LambdaInvokeJsonPathProps,MediaConvertCreateJobJsonPathProps,SageMakerCreateEndpointConfigJsonPathProps,SageMakerCreateEndpointJsonPathProps,SageMakerCreateModelJsonPathProps,SageMakerCreateTrainingJobJsonPathProps,SageMakerCreateTransformJobJsonPathProps,SageMakerUpdateEndpointJsonPathProps,SnsPublishJsonPathProps,SqsSendMessageJsonPathProps,StepFunctionsInvokeActivityJsonPathProps,StepFunctionsStartExecutionJsonPathProps
- All Known Implementing Classes:
AthenaGetQueryExecutionJsonPathProps.Jsii$Proxy,AthenaGetQueryResultsJsonPathProps.Jsii$Proxy,AthenaStartQueryExecutionJsonPathProps.Jsii$Proxy,AthenaStopQueryExecutionJsonPathProps.Jsii$Proxy,BatchSubmitJobJsonPathProps.Jsii$Proxy,BedrockInvokeModelJsonPathProps.Jsii$Proxy,CallApiGatewayEndpointJsonPathBaseProps.Jsii$Proxy,CallApiGatewayHttpApiEndpointJsonPathProps.Jsii$Proxy,CallApiGatewayRestApiEndpointJsonPathProps.Jsii$Proxy,CallAwsServiceCrossRegionJsonPathProps.Jsii$Proxy,CallAwsServiceJsonPathProps.Jsii$Proxy,CodeBuildStartBuildBatchJsonPathProps.Jsii$Proxy,CodeBuildStartBuildJsonPathProps.Jsii$Proxy,DynamoDeleteItemJsonPathProps.Jsii$Proxy,DynamoGetItemJsonPathProps.Jsii$Proxy,DynamoPutItemJsonPathProps.Jsii$Proxy,DynamoUpdateItemJsonPathProps.Jsii$Proxy,EcsRunTaskJsonPathProps.Jsii$Proxy,EksCallJsonPathProps.Jsii$Proxy,EmrAddStepJsonPathProps.Jsii$Proxy,EmrCancelStepJsonPathProps.Jsii$Proxy,EmrContainersCreateVirtualClusterJsonPathProps.Jsii$Proxy,EmrContainersDeleteVirtualClusterJsonPathProps.Jsii$Proxy,EmrContainersStartJobRunJsonPathProps.Jsii$Proxy,EmrCreateClusterJsonPathProps.Jsii$Proxy,EmrModifyInstanceFleetByNameJsonPathProps.Jsii$Proxy,EmrModifyInstanceGroupByNameJsonPathProps.Jsii$Proxy,EmrSetClusterTerminationProtectionJsonPathProps.Jsii$Proxy,EmrTerminateClusterJsonPathProps.Jsii$Proxy,EventBridgePutEventsJsonPathProps.Jsii$Proxy,EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Jsii$Proxy,GlueDataBrewStartJobRunJsonPathProps.Jsii$Proxy,GlueStartCrawlerRunJsonPathProps.Jsii$Proxy,GlueStartJobRunJsonPathProps.Jsii$Proxy,HttpInvokeJsonPathProps.Jsii$Proxy,LambdaInvokeJsonPathProps.Jsii$Proxy,MediaConvertCreateJobJsonPathProps.Jsii$Proxy,SageMakerCreateEndpointConfigJsonPathProps.Jsii$Proxy,SageMakerCreateEndpointJsonPathProps.Jsii$Proxy,SageMakerCreateModelJsonPathProps.Jsii$Proxy,SageMakerCreateTrainingJobJsonPathProps.Jsii$Proxy,SageMakerCreateTransformJobJsonPathProps.Jsii$Proxy,SageMakerUpdateEndpointJsonPathProps.Jsii$Proxy,SnsPublishJsonPathProps.Jsii$Proxy,SqsSendMessageJsonPathProps.Jsii$Proxy,StepFunctionsInvokeActivityJsonPathProps.Jsii$Proxy,StepFunctionsStartExecutionJsonPathProps.Jsii$Proxy,TaskStateJsonPathBaseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:47.914Z")
@Stability(Stable)
public interface TaskStateJsonPathBaseProps
extends software.amazon.jsii.JsiiSerializable, StateBaseProps, TaskStateBaseOptions, AssignableStateOptions, JsonPathCommonOptions
Props that are common to all tasks that using JSONPath.
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 resultSelector;
TaskRole taskRole;
Timeout timeout;
TaskStateJsonPathBaseProps taskStateJsonPathBaseProps = TaskStateJsonPathBaseProps.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")
.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 classA builder forTaskStateJsonPathBasePropsstatic final classAn implementation forTaskStateJsonPathBaseProps -
Method Summary
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssignMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions
getInputPath, getOutputPathMethods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateNameMethods 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
TaskStateJsonPathBaseProps.BuilderofTaskStateJsonPathBaseProps
-