Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class HttpSqsIntegration.Builder

java.lang.Object

software.amazon.awscdk.aws_apigatewayv2_integrations.HttpSqsIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpSqsIntegration>

Enclosing class:

HttpSqsIntegration

@Stability(Stable)
public static final class HttpSqsIntegration.Builder
extends Object
implements software.amazon.jsii.Builder<HttpSqsIntegration>

A fluent builder for HttpSqsIntegration.

Method Summary

Modifier and Type	Method	Description
HttpSqsIntegration	build()
static HttpSqsIntegration.Builder	create(String id)
HttpSqsIntegration.Builder	parameterMapping(ParameterMapping parameterMapping)	Specifies how to transform HTTP requests before sending them to the backend.
HttpSqsIntegration.Builder	queue(IQueue queue)	SQS queue that Integrates with API Gateway.
HttpSqsIntegration.Builder	subtype(HttpIntegrationSubtype subtype)	The subtype of the HTTP integration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static HttpSqsIntegration.Builder create(String id)

Parameters:

id - id of the underlying integration construct. This parameter is required.

Returns:

a new instance of HttpSqsIntegration.Builder.

queue

@Stability(Stable)
public HttpSqsIntegration.Builder queue(IQueue queue)

SQS queue that Integrates with API Gateway.

Parameters:

queue - SQS queue that Integrates with API Gateway. This parameter is required.

Returns:

this

parameterMapping

@Stability(Stable)
public HttpSqsIntegration.Builder parameterMapping(ParameterMapping 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.

Parameters:

parameterMapping - Specifies how to transform HTTP requests before sending them to the backend. This parameter is required.

Returns:

this

See Also:

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

subtype

@Stability(Stable)
public HttpSqsIntegration.Builder subtype(HttpIntegrationSubtype subtype)

The subtype of the HTTP integration.

Only subtypes starting with SQS_ can be specified.

Default: HttpIntegrationSubtype.SQS_SEND_MESSAGE

Parameters:

subtype - The subtype of the HTTP integration. This parameter is required.

Returns:

this

build

@Stability(Stable)
public HttpSqsIntegration build()

Specified by:

build in interface software.amazon.jsii.Builder<HttpSqsIntegration>

Returns:

a newly built instance of HttpSqsIntegration.