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

Interface HttpInvokeJsonataProps

All Superinterfaces:
AssignableStateOptions, software.amazon.jsii.JsiiSerializable, JsonataCommonOptions, StateBaseProps, TaskStateBaseOptions, TaskStateJsonataBaseProps
All Known Implementing Classes:
HttpInvokeJsonataProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:16.311Z") @Stability(Stable) public interface HttpInvokeJsonataProps extends software.amazon.jsii.JsiiSerializable, TaskStateJsonataBaseProps
Properties for calling an external HTTP endpoint with HttpInvoke using JSONata.

Example: 

 import software.amazon.awscdk.services.events.*;
 Connection connection;
 HttpInvoke getIssue = HttpInvoke.jsonata(this, "Get Issue", HttpInvokeJsonataProps.builder()
         .connection(connection)
         .apiRoot("{% 'https://' & $states.input.hostname %}")
         .apiEndpoint(TaskInput.fromText("{% 'issues/' & $states.input.issue.id %}"))
         .method(TaskInput.fromText("GET"))
         // Parse the API call result to object and set to the variables
         .assign(Map.of(
                 "hostname", "{% $states.input.hostname %}",
                 "issue", "{% $parse($states.result.ResponseBody) %}"))
         .build());
 HttpInvoke updateLabels = HttpInvoke.jsonata(this, "Update Issue Labels", HttpInvokeJsonataProps.builder()
         .connection(connection)
         .apiRoot("{% 'https://' & $states.input.hostname %}")
         .apiEndpoint(TaskInput.fromText("{% 'issues/' & $states.input.issue.id & 'labels' %}"))
         .method(TaskInput.fromText("POST"))
         .body(TaskInput.fromObject(Map.of(
                 "labels", "{% [$type, $component] %}")))
         .build());
 Pass notMatchTitleTemplate = Pass.jsonata(this, "Not Match Title Template");
 Chain definition = getIssue.next(Choice.jsonata(this, "Match Title Template?").when(Condition.jsonata("{% $contains($issue.title, /(feat)|(fix)|(chore)(w*):.*/) %}"), updateLabels, ChoiceTransitionOptions.builder()
         .assign(Map.of(
                 "type", "{% $match($states.input.title, /(w*)((.*))/).groups[0] %}",
                 "component", "{% $match($states.input.title, /(w*)((.*))/).groups[1] %}"))
         .build()).otherwise(notMatchTitleTemplate));
 StateMachine.Builder.create(this, "StateMachine")
         .definitionBody(DefinitionBody.fromChainable(definition))
         .timeout(Duration.minutes(5))
         .comment("automate issue labeling state machine")
         .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 HttpInvokeJsonataProps.Builder builder()
      Returns:
      a HttpInvokeJsonataProps.Builder of HttpInvokeJsonataProps