Package software.amazon.awscdk.aws_apigatewayv2_integrations

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 Classes

Modifier and Type	Interface	Description
static final class	HttpStepFunctionsIntegrationProps.Builder	A builder for HttpStepFunctionsIntegrationProps
static final class	HttpStepFunctionsIntegrationProps.Jsii$Proxy	An implementation for HttpStepFunctionsIntegrationProps

Method Summary

Modifier and Type	Method	Description
static HttpStepFunctionsIntegrationProps.Builder	builder()
default ParameterMapping	getParameterMapping()	Specifies how to transform HTTP requests before sending them to the backend.
StateMachine	getStateMachine()	Statemachine that Integrates with API Gateway.
default HttpIntegrationSubtype	getSubtype()	The subtype of the HTTP integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStateMachine

@Stability(Stable)
@NotNull
StateMachine getStateMachine()

Statemachine that Integrates with API Gateway.

getParameterMapping

@Stability(Stable)
@Nullable
default ParameterMapping getParameterMapping()

Specifies how to transform HTTP requests before sending them to the backend.

When the subtype is either START_EXECUTION or START_SYNC_EXECUTION, it is necessary to specify the StateMachineArn. Conversely, when the subtype is STOP_EXECUTION, the ExecutionArn must be specified.

Default: - specify only `StateMachineArn`

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

getSubtype

@Stability(Stable)
@Nullable
default HttpIntegrationSubtype getSubtype()

The subtype of the HTTP integration.

Only subtypes starting with STEPFUNCTIONS_ can be specified.

Default: HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION

builder

@Stability(Stable)
static HttpStepFunctionsIntegrationProps.Builder builder()

Returns:

a HttpStepFunctionsIntegrationProps.Builder of HttpStepFunctionsIntegrationProps