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

Class CallApiGatewayHttpApiEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayHttpApiEndpoint

All Implemented Interfaces:

IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-06-13T09:19:47.242Z")
@Stability(Stable)
public class CallApiGatewayHttpApiEndpoint
extends TaskStateBase

Call HTTP API endpoint as a Task.

Example:

 import software.amazon.awscdk.services.apigatewayv2.*;
 HttpApi httpApi = new HttpApi(this, "MyHttpApi");
 CallApiGatewayHttpApiEndpoint invokeTask = CallApiGatewayHttpApiEndpoint.Builder.create(this, "Call HTTP API")
         .apiId(httpApi.getApiId())
         .apiStack(Stack.of(httpApi))
         .method(HttpMethod.GET)
         .build();
 

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CallApiGatewayHttpApiEndpoint.Builder	A fluent builder for CallApiGatewayHttpApiEndpoint.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CallApiGatewayHttpApiEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CallApiGatewayHttpApiEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	CallApiGatewayHttpApiEndpoint(software.constructs.Construct scope, String id, CallApiGatewayHttpApiEndpointProps props)

Method Summary

Modifier and Type	Method	Description
protected List<PolicyStatement>	createPolicyStatements()
protected String	getApiEndpoint()
protected String	getArnForExecuteApi()
protected String	getStageName()
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()
static CallApiGatewayHttpApiEndpoint	jsonata(software.constructs.Construct scope, String id, CallApiGatewayHttpApiEndpointJsonataProps props)	Call HTTP API endpoint as a Task using JSONata.
static CallApiGatewayHttpApiEndpoint	jsonPath(software.constructs.Construct scope, String id, CallApiGatewayHttpApiEndpointJsonPathProps props)	Call HTTP API endpoint as a Task using JSONPath.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getArguments, getAssign, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getOutputs, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getQueryLanguage, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderAssign, renderAssign, renderBranches, renderChoices, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderQueryLanguage, renderQueryLanguage, renderResultSelector, renderRetryCatch, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateState

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

CallApiGatewayHttpApiEndpoint

protected CallApiGatewayHttpApiEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

CallApiGatewayHttpApiEndpoint

protected CallApiGatewayHttpApiEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CallApiGatewayHttpApiEndpoint

@Stability(Stable)
public CallApiGatewayHttpApiEndpoint(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CallApiGatewayHttpApiEndpointProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props - This parameter is required.

Method Details

jsonata

@Stability(Stable)
@NotNull
public static CallApiGatewayHttpApiEndpoint jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CallApiGatewayHttpApiEndpointJsonataProps props)

Call HTTP API endpoint as a Task using JSONata.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html

jsonPath

@Stability(Stable)
@NotNull
public static CallApiGatewayHttpApiEndpoint jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CallApiGatewayHttpApiEndpointJsonPathProps props)

Call HTTP API endpoint as a Task using JSONPath.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html

createPolicyStatements

@Stability(Stable)
@NotNull
protected List<PolicyStatement> createPolicyStatements()

getApiEndpoint

@Stability(Stable)
@NotNull
protected String getApiEndpoint()

getArnForExecuteApi

@Stability(Stable)
@NotNull
protected String getArnForExecuteApi()

getStageName

@Stability(Stable)
@Nullable
protected String getStageName()

getTaskMetrics

@Stability(Stable)
@Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(Stable)
@Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase