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

Interface HttpInvokeProps

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

Example: 

 import software.amazon.awscdk.services.events.*;
 Connection connection = Connection.Builder.create(this, "Connection")
         .authorization(Authorization.basic("username", SecretValue.unsafePlainText("password")))
         .build();
 HttpInvoke.Builder.create(this, "Invoke HTTP API")
         .apiRoot("https://api.example.com")
         .apiEndpoint(TaskInput.fromText(JsonPath.format("resource/{}/details", JsonPath.stringAt("$.resourceId"))))
         .body(TaskInput.fromObject(Map.of("foo", "bar")))
         .connection(connection)
         .headers(TaskInput.fromObject(Map.of("Content-Type", "application/json")))
         .method(TaskInput.fromText("POST"))
         .queryStringParameters(TaskInput.fromObject(Map.of("id", "123")))
         .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 HttpInvokeProps.Builder builder()
      Returns:
      a HttpInvokeProps.Builder of HttpInvokeProps