@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:29.400Z") public class CallApiGatewayRestApiEndpoint extends TaskStateBase
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();
Modifier and Type | Class and Description |
---|---|
static class |
CallApiGatewayRestApiEndpoint.Builder
A fluent builder for
CallApiGatewayRestApiEndpoint . |
INextable.Jsii$Default
IChainable.Jsii$Default
IConstruct.Jsii$Default
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) |
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() |
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
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
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
protected CallApiGatewayRestApiEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
protected CallApiGatewayRestApiEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CallApiGatewayRestApiEndpoint(software.constructs.Construct scope, java.lang.String id, CallApiGatewayRestApiEndpointProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.protected java.util.List<PolicyStatement> createPolicyStatements()
protected java.lang.String getApiEndpoint()
protected java.lang.String getArnForExecuteApi()
protected java.lang.String getStageName()
protected TaskMetricsConfig getTaskMetrics()
getTaskMetrics
in class TaskStateBase
protected java.util.List<PolicyStatement> getTaskPolicies()
getTaskPolicies
in class TaskStateBase