Package software.amazon.awsconstructs.services.lambdasqslambda

Class LambdaToSqsToLambdaProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdasqslambda.LambdaToSqsToLambdaProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToSqsToLambdaProps>

Enclosing interface:

LambdaToSqsToLambdaProps

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

A builder for LambdaToSqsToLambdaProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LambdaToSqsToLambdaProps	build()	Builds the configured instance.
LambdaToSqsToLambdaProps.Builder	consumerLambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps consumerLambdaFunctionProps)	Sets the value of LambdaToSqsToLambdaProps.getConsumerLambdaFunctionProps()
LambdaToSqsToLambdaProps.Builder	deadLetterQueueProps(software.amazon.awscdk.services.sqs.QueueProps deadLetterQueueProps)	Sets the value of LambdaToSqsToLambdaProps.getDeadLetterQueueProps()
LambdaToSqsToLambdaProps.Builder	deployDeadLetterQueue(Boolean deployDeadLetterQueue)	Sets the value of LambdaToSqsToLambdaProps.getDeployDeadLetterQueue()
LambdaToSqsToLambdaProps.Builder	deployVpc(Boolean deployVpc)	Sets the value of LambdaToSqsToLambdaProps.getDeployVpc()
LambdaToSqsToLambdaProps.Builder	existingConsumerLambdaObj(software.amazon.awscdk.services.lambda.Function existingConsumerLambdaObj)	Sets the value of LambdaToSqsToLambdaProps.getExistingConsumerLambdaObj()
LambdaToSqsToLambdaProps.Builder	existingProducerLambdaObj(software.amazon.awscdk.services.lambda.Function existingProducerLambdaObj)	Sets the value of LambdaToSqsToLambdaProps.getExistingProducerLambdaObj()
LambdaToSqsToLambdaProps.Builder	existingQueueObj(software.amazon.awscdk.services.sqs.Queue existingQueueObj)	Sets the value of LambdaToSqsToLambdaProps.getExistingQueueObj()
LambdaToSqsToLambdaProps.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)	Sets the value of LambdaToSqsToLambdaProps.getExistingVpc()
LambdaToSqsToLambdaProps.Builder	maxReceiveCount(Number maxReceiveCount)	Sets the value of LambdaToSqsToLambdaProps.getMaxReceiveCount()
LambdaToSqsToLambdaProps.Builder	producerLambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps producerLambdaFunctionProps)	Sets the value of LambdaToSqsToLambdaProps.getProducerLambdaFunctionProps()
LambdaToSqsToLambdaProps.Builder	queueEnvironmentVariableName(String queueEnvironmentVariableName)	Sets the value of LambdaToSqsToLambdaProps.getQueueEnvironmentVariableName()
LambdaToSqsToLambdaProps.Builder	queueProps(software.amazon.awscdk.services.sqs.QueueProps queueProps)	Sets the value of LambdaToSqsToLambdaProps.getQueueProps()
LambdaToSqsToLambdaProps.Builder	sqsEventSourceProps(software.amazon.awscdk.services.lambda.eventsources.SqsEventSourceProps sqsEventSourceProps)	Sets the value of LambdaToSqsToLambdaProps.getSqsEventSourceProps()
LambdaToSqsToLambdaProps.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)	Sets the value of LambdaToSqsToLambdaProps.getVpcProps()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

consumerLambdaFunctionProps

public LambdaToSqsToLambdaProps.Builder consumerLambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps consumerLambdaFunctionProps)

Sets the value of LambdaToSqsToLambdaProps.getConsumerLambdaFunctionProps()

Parameters:

consumerLambdaFunctionProps - Optional user-provided properties to override the default properties for the consumer Lambda function.

Returns:

this

deadLetterQueueProps

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

Sets the value of LambdaToSqsToLambdaProps.getDeadLetterQueueProps()

Parameters:

deadLetterQueueProps - Optional user-provided props to override the default props for the dead letter queue. Only used if the deployDeadLetterQueue property is set to true.

Returns:

this

deployDeadLetterQueue

public LambdaToSqsToLambdaProps.Builder deployDeadLetterQueue(Boolean deployDeadLetterQueue)

Sets the value of LambdaToSqsToLambdaProps.getDeployDeadLetterQueue()

Parameters:

deployDeadLetterQueue - Whether to create a secondary queue to be used as a dead letter queue. Defaults to true.

Returns:

this

deployVpc

public LambdaToSqsToLambdaProps.Builder deployVpc(Boolean deployVpc)

Sets the value of LambdaToSqsToLambdaProps.getDeployVpc()

Parameters:

deployVpc - Whether to deploy a new VPC.

Returns:

this

existingConsumerLambdaObj

public LambdaToSqsToLambdaProps.Builder existingConsumerLambdaObj(software.amazon.awscdk.services.lambda.Function existingConsumerLambdaObj)

Sets the value of LambdaToSqsToLambdaProps.getExistingConsumerLambdaObj()

Parameters:

existingConsumerLambdaObj - An optional, existing Lambda function to be used instead of the default function for receiving/consuming messages from the queue. Providing both this and consumerLambdaFunctionProps will cause an error.

Returns:

this

existingProducerLambdaObj

public LambdaToSqsToLambdaProps.Builder existingProducerLambdaObj(software.amazon.awscdk.services.lambda.Function existingProducerLambdaObj)

Sets the value of LambdaToSqsToLambdaProps.getExistingProducerLambdaObj()

Parameters:

existingProducerLambdaObj - An optional, existing Lambda function to be used instead of the default function for sending messages to the queue. Providing both this and producerLambdaFunctionProps property will cause an error.

Returns:

this

existingQueueObj

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

Sets the value of LambdaToSqsToLambdaProps.getExistingQueueObj()

Parameters:

existingQueueObj - An optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.

Returns:

this

existingVpc

public LambdaToSqsToLambdaProps.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)

Sets the value of LambdaToSqsToLambdaProps.getExistingVpc()

Parameters:

existingVpc - An existing VPC for the construct to use (construct will NOT create a new VPC in this case).

Returns:

this

maxReceiveCount

public LambdaToSqsToLambdaProps.Builder maxReceiveCount(Number maxReceiveCount)

Sets the value of LambdaToSqsToLambdaProps.getMaxReceiveCount()

Parameters:

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

Returns:

this

producerLambdaFunctionProps

public LambdaToSqsToLambdaProps.Builder producerLambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps producerLambdaFunctionProps)

Sets the value of LambdaToSqsToLambdaProps.getProducerLambdaFunctionProps()

Parameters:

producerLambdaFunctionProps - Optional user-provided properties to override the default properties for the producer Lambda function.

Returns:

this

queueEnvironmentVariableName

public LambdaToSqsToLambdaProps.Builder queueEnvironmentVariableName(String queueEnvironmentVariableName)

Sets the value of LambdaToSqsToLambdaProps.getQueueEnvironmentVariableName()

Parameters:

queueEnvironmentVariableName - Optional Name for the Lambda function environment variable set to the URL of the queue.

Returns:

this

queueProps

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

Sets the value of LambdaToSqsToLambdaProps.getQueueProps()

Parameters:

queueProps - Optional user-provided properties to override the default properties for the SQS queue.

Returns:

this

sqsEventSourceProps

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

Sets the value of LambdaToSqsToLambdaProps.getSqsEventSourceProps()

Parameters:

sqsEventSourceProps - Optional user provided properties for the queue event source.

Returns:

this

vpcProps

public LambdaToSqsToLambdaProps.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)

Sets the value of LambdaToSqsToLambdaProps.getVpcProps()

Parameters:

vpcProps - Properties to override default properties if deployVpc is true.

Returns:

this

build

public LambdaToSqsToLambdaProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LambdaToSqsToLambdaProps

Throws:

NullPointerException - if any required attribute was not provided