HttpSqsIntegrationProps

class aws_cdk.aws_apigatewayv2_integrations.HttpSqsIntegrationProps(*, queue, parameter_mapping=None, subtype=None)

Bases: object

Properties to initialize HttpSqsIntegration.

Parameters:

queue (IQueue) – SQS queue that Integrates with API Gateway.
parameter_mapping (Optional[ParameterMapping]) – 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.
subtype (Optional[HttpIntegrationSubtype]) – The subtype of the HTTP integration. Only subtypes starting with SQS_ can be specified. Default: HttpIntegrationSubtype.SQS_SEND_MESSAGE

ExampleMetadata:

infused

Example:

import aws_cdk.aws_sqs as sqs
from aws_cdk.aws_apigatewayv2_integrations import HttpSqsIntegration

# queue: sqs.IQueue
# http_api: apigwv2.HttpApi


# default integration (send message)
http_api.add_routes(
    path="/default",
    methods=[apigwv2.HttpMethod.POST],
    integration=HttpSqsIntegration("defaultIntegration",
        queue=queue
    )
)
# send message integration
http_api.add_routes(
    path="/send-message",
    methods=[apigwv2.HttpMethod.POST],
    integration=HttpSqsIntegration("sendMessageIntegration",
        queue=queue,
        subtype=apigwv2.HttpIntegrationSubtype.SQS_SEND_MESSAGE
    )
)
# receive message integration
http_api.add_routes(
    path="/receive-message",
    methods=[apigwv2.HttpMethod.POST],
    integration=HttpSqsIntegration("receiveMessageIntegration",
        queue=queue,
        subtype=apigwv2.HttpIntegrationSubtype.SQS_RECEIVE_MESSAGE
    )
)
# delete message integration
http_api.add_routes(
    path="/delete-message",
    methods=[apigwv2.HttpMethod.POST],
    integration=HttpSqsIntegration("deleteMessageIntegration",
        queue=queue,
        subtype=apigwv2.HttpIntegrationSubtype.SQS_DELETE_MESSAGE
    )
)
# purge queue integration
http_api.add_routes(
    path="/purge-queue",
    methods=[apigwv2.HttpMethod.POST],
    integration=HttpSqsIntegration("purgeQueueIntegration",
        queue=queue,
        subtype=apigwv2.HttpIntegrationSubtype.SQS_PURGE_QUEUE
    )
)

Attributes

parameter_mapping

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:: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html

queue: SQS queue that Integrates with API Gateway.

subtype

The subtype of the HTTP integration.

Only subtypes starting with SQS_ can be specified.

Default:: HttpIntegrationSubtype.SQS_SEND_MESSAGE