software.amazon.awscdk.services.stepfunctions.tasks

Class CallApiGatewayRestApiEndpoint

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:29.400Z")
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 and Description
static class	CallApiGatewayRestApiEndpoint.Builder A fluent builder for CallApiGatewayRestApiEndpoint.

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

INextable.Jsii$Default

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CallApiGatewayRestApiEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CallApiGatewayRestApiEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	CallApiGatewayRestApiEndpoint(software.constructs.Construct scope, java.lang.String id, CallApiGatewayRestApiEndpointProps props)

Method Summary

Modifier and Type	Method and Description
protected java.util.List<PolicyStatement>	createPolicyStatements()
protected java.lang.String	getApiEndpoint()
protected java.lang.String	getArnForExecuteApi()
protected java.lang.String	getStageName()
protected TaskMetricsConfig	getTaskMetrics()
protected java.util.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 java.lang.Object

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

Constructor Detail

CallApiGatewayRestApiEndpoint

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

CallApiGatewayRestApiEndpoint

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

CallApiGatewayRestApiEndpoint

public CallApiGatewayRestApiEndpoint(software.constructs.Construct scope,
                                     java.lang.String id,
                                     CallApiGatewayRestApiEndpointProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

createPolicyStatements

protected java.util.List<PolicyStatement> createPolicyStatements()

getApiEndpoint

protected java.lang.String getApiEndpoint()

getArnForExecuteApi

protected java.lang.String getArnForExecuteApi()

getStageName

protected java.lang.String getStageName()

getTaskMetrics

protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

protected java.util.List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase