software.amazon.awsconstructs.services.sqslambda

Interface SqsToLambdaProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SqsToLambdaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-12-02T14:12:25.624Z")
public interface SqsToLambdaProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SqsToLambdaProps.Builder	builder()
default software.amazon.awscdk.services.sqs.QueueProps	getDeadLetterQueueProps() Optional user provided properties for the dead letter queue.
default Boolean	getDeployDeadLetterQueue() Whether to deploy a secondary queue to be used as a dead letter queue.
default software.amazon.awscdk.services.lambda.Function	getExistingLambdaObj() Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
default software.amazon.awscdk.services.sqs.Queue	getExistingQueueObj() Existing instance of SQS queue object, Providing both this and queueProps will cause an error.
default software.amazon.awscdk.services.lambda.FunctionProps	getLambdaFunctionProps() User provided props to override the default props for the Lambda function.
default Number	getMaxReceiveCount() The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
default software.amazon.awscdk.services.sqs.QueueProps	getQueueProps() Optional user provided properties.
default software.amazon.awscdk.services.lambda.eventsources.SqsEventSourceProps	getSqsEventSourceProps() Optional user provided properties for the queue event source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeadLetterQueueProps

@Nullable
default software.amazon.awscdk.services.sqs.QueueProps getDeadLetterQueueProps()

Optional user provided properties for the dead letter queue.

Default: - Default props are used

getDeployDeadLetterQueue

@Nullable
default Boolean getDeployDeadLetterQueue()

Whether to deploy a secondary queue to be used as a dead letter queue.

Default: - true.

getExistingLambdaObj

@Nullable
default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()

Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.

Default: - None

getExistingQueueObj

@Nullable
default software.amazon.awscdk.services.sqs.Queue getExistingQueueObj()

Existing instance of SQS queue object, Providing both this and queueProps will cause an error.

Default: - Default props are used

getLambdaFunctionProps

@Nullable
default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()

User provided props to override the default props for the Lambda function.

Default: - Default properties are used.

getMaxReceiveCount

@Nullable
default Number getMaxReceiveCount()

The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.

Default: - required field if deployDeadLetterQueue=true.

getQueueProps

@Nullable
default software.amazon.awscdk.services.sqs.QueueProps getQueueProps()

Optional user provided properties.

Default: - Default props are used

getSqsEventSourceProps

@Nullable
default software.amazon.awscdk.services.lambda.eventsources.SqsEventSourceProps getSqsEventSourceProps()

Optional user provided properties for the queue event source.

Default: - Default props are used

builder

static SqsToLambdaProps.Builder builder()

Returns:

a SqsToLambdaProps.Builder of SqsToLambdaProps