Class HttpStepFunctionsIntegration
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration
software.amazon.awscdk.aws_apigatewayv2_integrations.HttpStepFunctionsIntegration
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:09.657Z")
@Stability(Stable)
public class HttpStepFunctionsIntegration
extends HttpRouteIntegration
The StepFunctions integration resource for HTTP API.
Example:
import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpStepFunctionsIntegration; import software.amazon.awscdk.services.stepfunctions.*; StateMachine stateMachine; HttpApi httpApi; httpApi.addRoutes(AddRoutesOptions.builder() .path("/start") .methods(List.of(HttpMethod.POST)) .integration(HttpStepFunctionsIntegration.Builder.create("StartExecutionIntegration") .stateMachine(stateMachine) .subtype(HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION) .build()) .build()); httpApi.addRoutes(AddRoutesOptions.builder() .path("/start-sync") .methods(List.of(HttpMethod.POST)) .integration(HttpStepFunctionsIntegration.Builder.create("StartSyncExecutionIntegration") .stateMachine(stateMachine) .subtype(HttpIntegrationSubtype.STEPFUNCTIONS_START_SYNC_EXECUTION) .build()) .build()); httpApi.addRoutes(AddRoutesOptions.builder() .path("/stop") .methods(List.of(HttpMethod.POST)) .integration(HttpStepFunctionsIntegration.Builder.create("StopExecutionIntegration") .stateMachine(stateMachine) .subtype(HttpIntegrationSubtype.STEPFUNCTIONS_STOP_EXECUTION) // For the `STOP_EXECUTION` subtype, it is necessary to specify the `executionArn`. .parameterMapping(new ParameterMapping().custom("ExecutionArn", "$request.querystring.executionArn")) .build()) .build());
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forHttpStepFunctionsIntegration
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Constructor Summary
ModifierConstructorDescriptionprotected
HttpStepFunctionsIntegration
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
HttpStepFunctionsIntegration
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionbind
(HttpRouteIntegrationBindOptions options) Bind this integration to the route.Methods inherited from class software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration
completeBind
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, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
HttpStepFunctionsIntegration
protected HttpStepFunctionsIntegration(software.amazon.jsii.JsiiObjectRef objRef) -
HttpStepFunctionsIntegration
protected HttpStepFunctionsIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
HttpStepFunctionsIntegration
@Stability(Stable) public HttpStepFunctionsIntegration(@NotNull String id, @NotNull HttpStepFunctionsIntegrationProps props) - Parameters:
id
- id of the underlying integration construct. This parameter is required.props
- properties to configure the integration. This parameter is required.
-
-
Method Details
-
bind
@Stability(Stable) @NotNull public HttpRouteIntegrationConfig bind(@NotNull HttpRouteIntegrationBindOptions options) Bind this integration to the route.- Specified by:
bind
in classHttpRouteIntegration
- Parameters:
options
- This parameter is required.
-