Package software.amazon.awscdk.services.stepfunctions.tasks

Interface HttpInvokeJsonPathProps

All Superinterfaces:
AssignableStateOptions, software.amazon.jsii.JsiiSerializable, JsonPathCommonOptions, StateBaseProps, TaskStateBaseOptions, TaskStateJsonPathBaseProps
All Known Implementing Classes:
HttpInvokeJsonPathProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:18.937Z") @Stability(Stable) public interface HttpInvokeJsonPathProps extends software.amazon.jsii.JsiiSerializable, TaskStateJsonPathBaseProps
Properties for calling an external HTTP endpoint with HttpInvoke 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.events.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 Object assign;
 Connection connection;
 Object resultSelector;
 TaskInput taskInput;
 TaskRole taskRole;
 Timeout timeout;
 HttpInvokeJsonPathProps httpInvokeJsonPathProps = HttpInvokeJsonPathProps.builder()
         .apiEndpoint(taskInput)
         .apiRoot("apiRoot")
         .connection(connection)
         .method(taskInput)
         // the properties below are optional
         .assign(Map.of(
                 "assignKey", assign))
         .body(taskInput)
         .comment("comment")
         .credentials(Credentials.builder()
                 .role(taskRole)
                 .build())
         .headers(taskInput)
         .heartbeat(Duration.minutes(30))
         .heartbeatTimeout(timeout)
         .inputPath("inputPath")
         .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
         .outputPath("outputPath")
         .queryLanguage(QueryLanguage.JSON_PATH)
         .queryStringParameters(taskInput)
         .resultPath("resultPath")
         .resultSelector(Map.of(
                 "resultSelectorKey", resultSelector))
         .stateName("stateName")
         .taskTimeout(timeout)
         .timeout(Duration.minutes(30))
         .urlEncodingFormat(URLEncodingFormat.BRACKETS)
         .build();

  • Method Details

    • getApiEndpoint

      @Stability(Stable) @NotNull TaskInput getApiEndpoint()
      The API endpoint to call, relative to apiRoot.

      Example: 

       TaskInput.fromText("path/to/resource");

    • getApiRoot

      @Stability(Stable) @NotNull String getApiRoot()
      Permissions are granted to call all resources under this path.

      Example: 

       "https://api.example.com";

    • getConnection

      @Stability(Stable) @NotNull IConnection getConnection()
      The EventBridge Connection to use for authentication.

    • getMethod

      @Stability(Stable) @NotNull TaskInput getMethod()
      The HTTP method to use.

      Example: 

       TaskInput.fromText("GET");

    • getBody

      @Stability(Stable) @Nullable default TaskInput getBody()
      The body to send to the HTTP endpoint.

      Default: - No body is sent with the request.

    • getHeaders

      @Stability(Stable) @Nullable default TaskInput getHeaders()
      The headers to send to the HTTP endpoint.

      Default: - No additional headers are added to the request.

      Example: 

       TaskInput.fromObject(Map.of("Content-Type", "application/json"));

    • getQueryStringParameters

      @Stability(Stable) @Nullable default TaskInput getQueryStringParameters()
      The query string parameters to send to the HTTP endpoint.

      Default: - No query string parameters are sent in the request.

    • getUrlEncodingFormat

      @Stability(Stable) @Nullable default URLEncodingFormat getUrlEncodingFormat()
      Determines whether to apply URL encoding to the request body, and which array encoding format to use.

      URLEncodingFormat.NONE passes the JSON-serialized RequestBody field as the HTTP request body. Otherwise, the HTTP request body is the URL-encoded form data of the RequestBody field using the specified array encoding format, and the Content-Type header is set to application/x-www-form-urlencoded.

      Default: - URLEncodingFormat.NONE

    • builder

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