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

Class CallApiGatewayRestApiEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayRestApiEndpoint

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.890Z")
@Stability(Stable)
public class CallApiGatewayRestApiEndpoint
extends TaskStateBase

Call REST API endpoint as a Task.

Be aware that the header values must be arrays. When passing the Task Token in the headers field WAIT_FOR_TASK_TOKEN integration, use JsonPath.array() to wrap the token in an array:

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

Example:

 import software.amazon.awscdk.services.apigateway.*;
 RestApi api;
 CallApiGatewayRestApiEndpoint.Builder.create(this, "Endpoint")
         .api(api)
         .stageName("Stage")
         .method(HttpMethod.PUT)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .headers(TaskInput.fromObject(Map.of(
                 "TaskToken", JsonPath.array(JsonPath.getTaskToken()))))
         .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	CallApiGatewayRestApiEndpoint.Builder	A fluent builder for CallApiGatewayRestApiEndpoint.

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.amazon.awscdk.core.IConstruct

IConstruct.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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CallApiGatewayRestApiEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CallApiGatewayRestApiEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	CallApiGatewayRestApiEndpoint(software.constructs.Construct scope, String id, CallApiGatewayRestApiEndpointProps 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()

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, whenBoundToGraph

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

addBranch, addChoice, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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

Constructor Details

CallApiGatewayRestApiEndpoint

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

CallApiGatewayRestApiEndpoint

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

CallApiGatewayRestApiEndpoint

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

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