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

Interface HttpInvokeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

HttpInvokeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:17.774Z")
@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("path/to/resource"))
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpInvokeProps.Builder	A builder for HttpInvokeProps
static final class	HttpInvokeProps.Jsii$Proxy	An implementation for HttpInvokeProps

Method Summary

Modifier and Type	Method	Description
static HttpInvokeProps.Builder	builder()
TaskInput	getApiEndpoint()	The API endpoint to call, relative to apiRoot.
String	getApiRoot()	Permissions are granted to call all resources under this path.
default TaskInput	getBody()	The body to send to the HTTP endpoint.
IConnection	getConnection()	The EventBridge Connection to use for authentication.
default TaskInput	getHeaders()	The headers to send to the HTTP endpoint.
TaskInput	getMethod()	The HTTP method to use.
default TaskInput	getQueryStringParameters()	The query string parameters to send to the HTTP endpoint.
default URLEncodingFormat	getUrlEncodingFormat()	Determines whether to apply URL encoding to the request body, and which array encoding format to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

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