Interface HttpStepFunctionsIntegrationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
HttpStepFunctionsIntegrationProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-08-15T01:32:43.153Z")
@Stability(Stable)
public interface HttpStepFunctionsIntegrationProps
extends software.amazon.jsii.JsiiSerializable
Properties to initialize
HttpStepFunctionsIntegration
.
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
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forHttpStepFunctionsIntegrationProps
static final class
An implementation forHttpStepFunctionsIntegrationProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default ParameterMapping
Specifies how to transform HTTP requests before sending them to the backend.Statemachine that Integrates with API Gateway.default HttpIntegrationSubtype
The subtype of the HTTP integration.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getStateMachine
Statemachine that Integrates with API Gateway. -
getParameterMapping
Specifies how to transform HTTP requests before sending them to the backend.When the subtype is either
START_EXECUTION
orSTART_SYNC_EXECUTION
, it is necessary to specify theStateMachineArn
. Conversely, when the subtype isSTOP_EXECUTION
, theExecutionArn
must be specified.Default: - specify only `StateMachineArn`
- See Also:
-
getSubtype
The subtype of the HTTP integration.Only subtypes starting with STEPFUNCTIONS_ can be specified.
Default: HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION
-
builder
-