Package software.amazon.awscdk.services.stepfunctions

Interface JsonPathCommonOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
AthenaGetQueryExecutionJsonPathProps, AthenaGetQueryExecutionProps, AthenaGetQueryResultsJsonPathProps, AthenaGetQueryResultsProps, AthenaStartQueryExecutionJsonPathProps, AthenaStartQueryExecutionProps, AthenaStopQueryExecutionJsonPathProps, AthenaStopQueryExecutionProps, BatchSubmitJobJsonPathProps, BatchSubmitJobProps, BedrockInvokeModelJsonPathProps, BedrockInvokeModelProps, CallApiGatewayEndpointBaseProps, CallApiGatewayEndpointJsonPathBaseProps, CallApiGatewayHttpApiEndpointJsonPathProps, CallApiGatewayHttpApiEndpointProps, CallApiGatewayRestApiEndpointJsonPathProps, CallApiGatewayRestApiEndpointProps, CallAwsServiceCrossRegionJsonPathProps, CallAwsServiceCrossRegionProps, CallAwsServiceJsonPathProps, CallAwsServiceProps, ChoiceJsonPathProps, ChoiceProps, CodeBuildStartBuildBatchJsonPathProps, CodeBuildStartBuildBatchProps, CodeBuildStartBuildJsonPathProps, CodeBuildStartBuildProps, DistributedMapJsonPathProps, DistributedMapProps, DynamoDeleteItemJsonPathProps, DynamoDeleteItemProps, DynamoGetItemJsonPathProps, DynamoGetItemProps, DynamoPutItemJsonPathProps, DynamoPutItemProps, DynamoUpdateItemJsonPathProps, DynamoUpdateItemProps, EcsRunTaskJsonPathProps, EcsRunTaskProps, EksCallJsonPathProps, EksCallProps, EmrAddStepJsonPathProps, EmrAddStepProps, EmrCancelStepJsonPathProps, EmrCancelStepProps, EmrContainersCreateVirtualClusterJsonPathProps, EmrContainersCreateVirtualClusterProps, EmrContainersDeleteVirtualClusterJsonPathProps, EmrContainersDeleteVirtualClusterProps, EmrContainersStartJobRunJsonPathProps, EmrContainersStartJobRunProps, EmrCreateClusterJsonPathProps, EmrCreateClusterProps, EmrModifyInstanceFleetByNameJsonPathProps, EmrModifyInstanceFleetByNameProps, EmrModifyInstanceGroupByNameJsonPathProps, EmrModifyInstanceGroupByNameProps, EmrSetClusterTerminationProtectionJsonPathProps, EmrSetClusterTerminationProtectionProps, EmrTerminateClusterJsonPathProps, EmrTerminateClusterProps, EvaluateExpressionProps, EventBridgePutEventsJsonPathProps, EventBridgePutEventsProps, EventBridgeSchedulerCreateScheduleTaskJsonPathProps, EventBridgeSchedulerCreateScheduleTaskProps, GlueDataBrewStartJobRunJsonPathProps, GlueDataBrewStartJobRunProps, GlueStartCrawlerRunJsonPathProps, GlueStartCrawlerRunProps, GlueStartJobRunJsonPathProps, GlueStartJobRunProps, HttpInvokeJsonPathProps, HttpInvokeProps, JsonPathStateProps, LambdaInvokeJsonPathProps, LambdaInvokeProps, MapBaseJsonPathOptions, MapBaseProps, MapJsonPathProps, MapProps, MediaConvertCreateJobJsonPathProps, MediaConvertCreateJobProps, ParallelJsonPathProps, ParallelProps, PassJsonPathProps, PassProps, SageMakerCreateEndpointConfigJsonPathProps, SageMakerCreateEndpointConfigProps, SageMakerCreateEndpointJsonPathProps, SageMakerCreateEndpointProps, SageMakerCreateModelJsonPathProps, SageMakerCreateModelProps, SageMakerCreateTrainingJobJsonPathProps, SageMakerCreateTrainingJobProps, SageMakerCreateTransformJobJsonPathProps, SageMakerCreateTransformJobProps, SageMakerUpdateEndpointJsonPathProps, SageMakerUpdateEndpointProps, SingleStateOptions, SnsPublishJsonPathProps, SnsPublishProps, SqsSendMessageJsonPathProps, SqsSendMessageProps, StateProps, StepFunctionsInvokeActivityJsonPathProps, StepFunctionsInvokeActivityProps, StepFunctionsStartExecutionJsonPathProps, StepFunctionsStartExecutionProps, SucceedJsonPathProps, SucceedProps, TaskStateBaseProps, TaskStateJsonPathBaseProps, WaitJsonPathProps
All Known Implementing Classes:
AthenaGetQueryExecutionJsonPathProps.Jsii$Proxy, AthenaGetQueryExecutionProps.Jsii$Proxy, AthenaGetQueryResultsJsonPathProps.Jsii$Proxy, AthenaGetQueryResultsProps.Jsii$Proxy, AthenaStartQueryExecutionJsonPathProps.Jsii$Proxy, AthenaStartQueryExecutionProps.Jsii$Proxy, AthenaStopQueryExecutionJsonPathProps.Jsii$Proxy, AthenaStopQueryExecutionProps.Jsii$Proxy, BatchSubmitJobJsonPathProps.Jsii$Proxy, BatchSubmitJobProps.Jsii$Proxy, BedrockInvokeModelJsonPathProps.Jsii$Proxy, BedrockInvokeModelProps.Jsii$Proxy, CallApiGatewayEndpointBaseProps.Jsii$Proxy, CallApiGatewayEndpointJsonPathBaseProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointJsonPathProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointProps.Jsii$Proxy, CallApiGatewayRestApiEndpointJsonPathProps.Jsii$Proxy, CallApiGatewayRestApiEndpointProps.Jsii$Proxy, CallAwsServiceCrossRegionJsonPathProps.Jsii$Proxy, CallAwsServiceCrossRegionProps.Jsii$Proxy, CallAwsServiceJsonPathProps.Jsii$Proxy, CallAwsServiceProps.Jsii$Proxy, ChoiceJsonPathProps.Jsii$Proxy, ChoiceProps.Jsii$Proxy, CodeBuildStartBuildBatchJsonPathProps.Jsii$Proxy, CodeBuildStartBuildBatchProps.Jsii$Proxy, CodeBuildStartBuildJsonPathProps.Jsii$Proxy, CodeBuildStartBuildProps.Jsii$Proxy, DistributedMapJsonPathProps.Jsii$Proxy, DistributedMapProps.Jsii$Proxy, DynamoDeleteItemJsonPathProps.Jsii$Proxy, DynamoDeleteItemProps.Jsii$Proxy, DynamoGetItemJsonPathProps.Jsii$Proxy, DynamoGetItemProps.Jsii$Proxy, DynamoPutItemJsonPathProps.Jsii$Proxy, DynamoPutItemProps.Jsii$Proxy, DynamoUpdateItemJsonPathProps.Jsii$Proxy, DynamoUpdateItemProps.Jsii$Proxy, EcsRunTaskJsonPathProps.Jsii$Proxy, EcsRunTaskProps.Jsii$Proxy, EksCallJsonPathProps.Jsii$Proxy, EksCallProps.Jsii$Proxy, EmrAddStepJsonPathProps.Jsii$Proxy, EmrAddStepProps.Jsii$Proxy, EmrCancelStepJsonPathProps.Jsii$Proxy, EmrCancelStepProps.Jsii$Proxy, EmrContainersCreateVirtualClusterJsonPathProps.Jsii$Proxy, EmrContainersCreateVirtualClusterProps.Jsii$Proxy, EmrContainersDeleteVirtualClusterJsonPathProps.Jsii$Proxy, EmrContainersDeleteVirtualClusterProps.Jsii$Proxy, EmrContainersStartJobRunJsonPathProps.Jsii$Proxy, EmrContainersStartJobRunProps.Jsii$Proxy, EmrCreateClusterJsonPathProps.Jsii$Proxy, EmrCreateClusterProps.Jsii$Proxy, EmrModifyInstanceFleetByNameJsonPathProps.Jsii$Proxy, EmrModifyInstanceFleetByNameProps.Jsii$Proxy, EmrModifyInstanceGroupByNameJsonPathProps.Jsii$Proxy, EmrModifyInstanceGroupByNameProps.Jsii$Proxy, EmrSetClusterTerminationProtectionJsonPathProps.Jsii$Proxy, EmrSetClusterTerminationProtectionProps.Jsii$Proxy, EmrTerminateClusterJsonPathProps.Jsii$Proxy, EmrTerminateClusterProps.Jsii$Proxy, EvaluateExpressionProps.Jsii$Proxy, EventBridgePutEventsJsonPathProps.Jsii$Proxy, EventBridgePutEventsProps.Jsii$Proxy, EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Jsii$Proxy, EventBridgeSchedulerCreateScheduleTaskProps.Jsii$Proxy, GlueDataBrewStartJobRunJsonPathProps.Jsii$Proxy, GlueDataBrewStartJobRunProps.Jsii$Proxy, GlueStartCrawlerRunJsonPathProps.Jsii$Proxy, GlueStartCrawlerRunProps.Jsii$Proxy, GlueStartJobRunJsonPathProps.Jsii$Proxy, GlueStartJobRunProps.Jsii$Proxy, HttpInvokeJsonPathProps.Jsii$Proxy, HttpInvokeProps.Jsii$Proxy, JsonPathCommonOptions.Jsii$Proxy, JsonPathStateProps.Jsii$Proxy, LambdaInvokeJsonPathProps.Jsii$Proxy, LambdaInvokeProps.Jsii$Proxy, MapBaseJsonPathOptions.Jsii$Proxy, MapBaseProps.Jsii$Proxy, MapJsonPathProps.Jsii$Proxy, MapProps.Jsii$Proxy, MediaConvertCreateJobJsonPathProps.Jsii$Proxy, MediaConvertCreateJobProps.Jsii$Proxy, ParallelJsonPathProps.Jsii$Proxy, ParallelProps.Jsii$Proxy, PassJsonPathProps.Jsii$Proxy, PassProps.Jsii$Proxy, SageMakerCreateEndpointConfigJsonPathProps.Jsii$Proxy, SageMakerCreateEndpointConfigProps.Jsii$Proxy, SageMakerCreateEndpointJsonPathProps.Jsii$Proxy, SageMakerCreateEndpointProps.Jsii$Proxy, SageMakerCreateModelJsonPathProps.Jsii$Proxy, SageMakerCreateModelProps.Jsii$Proxy, SageMakerCreateTrainingJobJsonPathProps.Jsii$Proxy, SageMakerCreateTrainingJobProps.Jsii$Proxy, SageMakerCreateTransformJobJsonPathProps.Jsii$Proxy, SageMakerCreateTransformJobProps.Jsii$Proxy, SageMakerUpdateEndpointJsonPathProps.Jsii$Proxy, SageMakerUpdateEndpointProps.Jsii$Proxy, SingleStateOptions.Jsii$Proxy, SnsPublishJsonPathProps.Jsii$Proxy, SnsPublishProps.Jsii$Proxy, SqsSendMessageJsonPathProps.Jsii$Proxy, SqsSendMessageProps.Jsii$Proxy, StateProps.Jsii$Proxy, StepFunctionsInvokeActivityJsonPathProps.Jsii$Proxy, StepFunctionsInvokeActivityProps.Jsii$Proxy, StepFunctionsStartExecutionJsonPathProps.Jsii$Proxy, StepFunctionsStartExecutionProps.Jsii$Proxy, SucceedJsonPathProps.Jsii$Proxy, SucceedProps.Jsii$Proxy, TaskStateBaseProps.Jsii$Proxy, TaskStateJsonPathBaseProps.Jsii$Proxy, WaitJsonPathProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.109.0 (build c221850)", date="2025-03-19T18:01:43.147Z") @Stability(Stable) public interface JsonPathCommonOptions extends software.amazon.jsii.JsiiSerializable
Option properties for JSONPath state.

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.*;
 JsonPathCommonOptions jsonPathCommonOptions = JsonPathCommonOptions.builder()
         .inputPath("inputPath")
         .outputPath("outputPath")
         .build();

  • Method Details

    • 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: $

    • getOutputPath

      @Stability(Stable) @Nullable default String getOutputPath()
      JSONPath expression to select part of the state to be the output to this state.

      May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

      Default: $

    • builder

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