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

Interface CallApiGatewayRestApiEndpointJsonPathProps

All Superinterfaces:

AssignableStateOptions, CallApiGatewayEndpointBaseOptions, CallApiGatewayEndpointJsonPathBaseProps, CallApiGatewayRestApiEndpointOptions, software.amazon.jsii.JsiiSerializable, JsonPathCommonOptions, StateBaseProps, TaskStateBaseOptions, TaskStateJsonPathBaseProps

All Known Implementing Classes:

CallApiGatewayRestApiEndpointJsonPathProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:18.718Z")
@Stability(Stable)
public interface CallApiGatewayRestApiEndpointJsonPathProps
extends software.amazon.jsii.JsiiSerializable, CallApiGatewayEndpointJsonPathBaseProps, CallApiGatewayRestApiEndpointOptions

Properties for calling an REST API Endpoint using JSONPath.

Example:

 import software.amazon.awscdk.services.apigateway.*;
 RestApi api;
 CallApiGatewayRestApiEndpoint.jsonPath(this, "Endpoint", CallApiGatewayRestApiEndpointJsonPathProps.builder()
         .api(api)
         .stageName("Stage")
         .method(HttpMethod.PUT)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .headers(TaskInput.fromObject(Map.of(
                 "TaskToken", JsonPath.array(JsonPath.getTaskToken()))))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Static Methods

Modifier and Type	Method	Description
static CallApiGatewayRestApiEndpointJsonPathProps.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.JsonPathCommonOptions

getInputPath, getOutputPath

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

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

getResultPath, getResultSelector

Method Details

builder

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

Returns:

a CallApiGatewayRestApiEndpointJsonPathProps.Builder of CallApiGatewayRestApiEndpointJsonPathProps