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

Interface CallApiGatewayRestApiEndpointJsonataProps

All Superinterfaces:

AssignableStateOptions, CallApiGatewayEndpointBaseOptions, CallApiGatewayEndpointJsonataBaseProps, CallApiGatewayRestApiEndpointOptions, software.amazon.jsii.JsiiSerializable, JsonataCommonOptions, StateBaseProps, TaskStateBaseOptions, TaskStateJsonataBaseProps

All Known Implementing Classes:

CallApiGatewayRestApiEndpointJsonataProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:48.039Z")
@Stability(Stable)
public interface CallApiGatewayRestApiEndpointJsonataProps
extends software.amazon.jsii.JsiiSerializable, CallApiGatewayEndpointJsonataBaseProps, CallApiGatewayRestApiEndpointOptions

Properties for calling an REST API Endpoint using JSONata.

Example:

 import software.amazon.awscdk.services.apigateway.*;
 RestApi api;
 CallApiGatewayRestApiEndpoint.jsonata(this, "Endpoint", CallApiGatewayRestApiEndpointJsonataProps.builder()
         .api(api)
         .stageName("Stage")
         .method(HttpMethod.PUT)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .headers(TaskInput.fromObject(Map.of(
                 "TaskToken", "{% States.Array($states.context.taskToken) %}")))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Static Methods

Modifier and Type	Method	Description
static CallApiGatewayRestApiEndpointJsonataProps.Builder	builder()

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

getAssign

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayEndpointBaseOptions

getApiPath, getAuthType, getHeaders, getMethod, getQueryParameters, getRequestBody

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayRestApiEndpointOptions

getApi, getRegion, getStageName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getOutputs

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

getComment, getQueryLanguage, getStateName

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

getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeout

Method Details

builder

@Stability(Stable)
static CallApiGatewayRestApiEndpointJsonataProps.Builder builder()

Returns:

a CallApiGatewayRestApiEndpointJsonataProps.Builder of CallApiGatewayRestApiEndpointJsonataProps