software.amazon.awsconstructs.services.sqslambda

Class SqsToLambda.Builder

java.lang.Object

software.amazon.awsconstructs.services.sqslambda.SqsToLambda.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SqsToLambda>

Enclosing class:

SqsToLambda

public static final class SqsToLambda.Builder
extends Object
implements software.amazon.jsii.Builder<SqsToLambda>

A fluent builder for SqsToLambda.

Method Summary

Modifier and Type	Method and Description
SqsToLambda	build()
static SqsToLambda.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
SqsToLambda.Builder	deadLetterQueueProps(software.amazon.awscdk.services.sqs.QueueProps deadLetterQueueProps) Optional user provided properties for the dead letter queue.
SqsToLambda.Builder	deployDeadLetterQueue(Boolean deployDeadLetterQueue) Whether to deploy a secondary queue to be used as a dead letter queue.
SqsToLambda.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
SqsToLambda.Builder	existingQueueObj(software.amazon.awscdk.services.sqs.Queue existingQueueObj) Existing instance of SQS queue object, Providing both this and queueProps will cause an error.
SqsToLambda.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) User provided props to override the default props for the Lambda function.
SqsToLambda.Builder	maxReceiveCount(Number maxReceiveCount) The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
SqsToLambda.Builder	queueProps(software.amazon.awscdk.services.sqs.QueueProps queueProps) Optional user provided properties.
SqsToLambda.Builder	sqsEventSourceProps(software.amazon.awscdk.services.lambda.eventsources.SqsEventSourceProps sqsEventSourceProps) Optional user provided properties for the dead letter queue.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SqsToLambda.Builder create(software.amazon.awscdk.core.Construct scope,
                                         String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of SqsToLambda.Builder.

deadLetterQueueProps

public SqsToLambda.Builder deadLetterQueueProps(software.amazon.awscdk.services.sqs.QueueProps deadLetterQueueProps)

Optional user provided properties for the dead letter queue.

Default: - Default props are used

Parameters:

deadLetterQueueProps - Optional user provided properties for the dead letter queue. This parameter is required.

Returns:

this

deployDeadLetterQueue

public SqsToLambda.Builder deployDeadLetterQueue(Boolean deployDeadLetterQueue)

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

Default: - true.

Parameters:

deployDeadLetterQueue - Whether to deploy a secondary queue to be used as a dead letter queue. This parameter is required.

Returns:

this

existingLambdaObj

public SqsToLambda.Builder existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)

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

Default: - None

Parameters:

existingLambdaObj - Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error. This parameter is required.

Returns:

this

existingQueueObj

public SqsToLambda.Builder existingQueueObj(software.amazon.awscdk.services.sqs.Queue existingQueueObj)

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

Default: - Default props are used

Parameters:

existingQueueObj - Existing instance of SQS queue object, Providing both this and queueProps will cause an error. This parameter is required.

Returns:

this

lambdaFunctionProps

public SqsToLambda.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

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

Default: - Default properties are used.

Parameters:

lambdaFunctionProps - User provided props to override the default props for the Lambda function. This parameter is required.

Returns:

this

maxReceiveCount

public SqsToLambda.Builder maxReceiveCount(Number maxReceiveCount)

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

Default: - required field if deployDeadLetterQueue=true.

Parameters:

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

Returns:

this

queueProps

public SqsToLambda.Builder queueProps(software.amazon.awscdk.services.sqs.QueueProps queueProps)

Optional user provided properties.

Default: - Default props are used

Parameters:

queueProps - Optional user provided properties. This parameter is required.

Returns:

this

sqsEventSourceProps

public SqsToLambda.Builder sqsEventSourceProps(software.amazon.awscdk.services.lambda.eventsources.SqsEventSourceProps sqsEventSourceProps)

Optional user provided properties for the dead letter queue.

Default: - Default props are used

Parameters:

sqsEventSourceProps - Optional user provided properties for the dead letter queue. This parameter is required.

Returns:

this

build

public SqsToLambda build()

Specified by:

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