Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class HttpSqsIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration

software.amazon.awscdk.aws_apigatewayv2_integrations.HttpSqsIntegration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.450Z")
@Stability(Stable)
public class HttpSqsIntegration
extends HttpRouteIntegration

The Sqs integration resource for HTTP API.

Example:

 import software.amazon.awscdk.services.sqs.*;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpSqsIntegration;
 IQueue queue;
 HttpApi httpApi;
 // default integration (send message)
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/default")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpSqsIntegration.Builder.create("defaultIntegration")
                 .queue(queue)
                 .build())
         .build());
 // send message integration
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/send-message")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpSqsIntegration.Builder.create("sendMessageIntegration")
                 .queue(queue)
                 .subtype(HttpIntegrationSubtype.SQS_SEND_MESSAGE)
                 .build())
         .build());
 // receive message integration
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/receive-message")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpSqsIntegration.Builder.create("receiveMessageIntegration")
                 .queue(queue)
                 .subtype(HttpIntegrationSubtype.SQS_RECEIVE_MESSAGE)
                 .build())
         .build());
 // delete message integration
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/delete-message")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpSqsIntegration.Builder.create("deleteMessageIntegration")
                 .queue(queue)
                 .subtype(HttpIntegrationSubtype.SQS_DELETE_MESSAGE)
                 .build())
         .build());
 // purge queue integration
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/purge-queue")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpSqsIntegration.Builder.create("purgeQueueIntegration")
                 .queue(queue)
                 .subtype(HttpIntegrationSubtype.SQS_PURGE_QUEUE)
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpSqsIntegration.Builder	A fluent builder for HttpSqsIntegration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpSqsIntegration(String id, HttpSqsIntegrationProps props)
protected	HttpSqsIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpSqsIntegration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
HttpRouteIntegrationConfig	bind(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

HttpSqsIntegration

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

HttpSqsIntegration

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

HttpSqsIntegration

@Stability(Stable)
public HttpSqsIntegration(@NotNull
 String id,
 @NotNull
 HttpSqsIntegrationProps 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 class HttpRouteIntegration

Parameters:

options - This parameter is required.