Package software.amazon.awscdk.aws_apigatewayv2_integrations

Interface HttpSqsIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpSqsIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.174Z")
@Stability(Stable)
public interface HttpSqsIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Properties to initialize HttpSqsIntegration.

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	Interface	Description
static final class	HttpSqsIntegrationProps.Builder	A builder for HttpSqsIntegrationProps
static final class	HttpSqsIntegrationProps.Jsii$Proxy	An implementation for HttpSqsIntegrationProps

Method Summary

Modifier and Type	Method	Description
static HttpSqsIntegrationProps.Builder	builder()
default ParameterMapping	getParameterMapping()	Specifies how to transform HTTP requests before sending them to the backend.
IQueue	getQueue()	SQS queue 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

getQueue

@Stability(Stable)
@NotNull
IQueue getQueue()

SQS queue that Integrates with API Gateway.

getParameterMapping

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

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

Default: - specify `QueueUrl`. Additionally, set `MessageBody` to `$request.body.MessageBody` for `SQS_SEND_MESSAGE` subtype and set `ReceiptHandle` to `$request.body.ReceiptHandle` for `SQS_DELETE_MESSAGE` subtype.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html

getSubtype

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

The subtype of the HTTP integration.

Only subtypes starting with SQS_ can be specified.

Default: HttpIntegrationSubtype.SQS_SEND_MESSAGE

builder

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

Returns:

a HttpSqsIntegrationProps.Builder of HttpSqsIntegrationProps