Package software.amazon.awsconstructs.services.lambdasqslambda

Interface LambdaToSqsToLambdaProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
LambdaToSqsToLambdaProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.111.0 (build cc021d6)", date="2025-05-01T20:29:02.491Z") public interface LambdaToSqsToLambdaProps extends software.amazon.jsii.JsiiSerializable

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    LambdaToSqsToLambdaProps.Builder
    A builder for LambdaToSqsToLambdaProps
    static final class 
    LambdaToSqsToLambdaProps.Jsii$Proxy
    An implementation for LambdaToSqsToLambdaProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static LambdaToSqsToLambdaProps.Builder
    builder()
     
    default software.amazon.awscdk.services.lambda.FunctionProps
    getConsumerLambdaFunctionProps()
    Optional user-provided properties to override the default properties for the consumer Lambda function.
    default software.amazon.awscdk.services.sqs.QueueProps
    getDeadLetterQueueProps()
    Optional user-provided props to override the default props for the dead letter queue.
    default Boolean
    getDeployDeadLetterQueue()
    Whether to create a secondary queue to be used as a dead letter queue.
    default Boolean
    getDeployVpc()
    Whether to deploy a new VPC.
    default software.amazon.awscdk.services.lambda.Function
    getExistingConsumerLambdaObj()
    An optional, existing Lambda function to be used instead of the default function for receiving/consuming messages from the queue.
    default software.amazon.awscdk.services.lambda.Function
    getExistingProducerLambdaObj()
    An optional, existing Lambda function to be used instead of the default function for sending messages to the queue.
    default software.amazon.awscdk.services.sqs.Queue
    getExistingQueueObj()
    An optional, existing SQS queue to be used instead of the default queue.
    default software.amazon.awscdk.services.ec2.IVpc
    getExistingVpc()
    An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
    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.lambda.FunctionProps
    getProducerLambdaFunctionProps()
    Optional user-provided properties to override the default properties for the producer Lambda function.
    default String
    getQueueEnvironmentVariableName()
    Optional Name for the Lambda function environment variable set to the URL of the queue.
    default software.amazon.awscdk.services.sqs.QueueProps
    getQueueProps()
    Optional user-provided properties to override the default properties for the SQS queue.
    default software.amazon.awscdk.services.lambda.eventsources.SqsEventSourceProps
    getSqsEventSourceProps()
    Optional user provided properties for the queue event source.
    default software.amazon.awscdk.services.ec2.VpcProps
    getVpcProps()
    Properties to override default properties if deployVpc is true.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getConsumerLambdaFunctionProps

      @Nullable default software.amazon.awscdk.services.lambda.FunctionProps getConsumerLambdaFunctionProps()
      Optional user-provided properties to override the default properties for the consumer Lambda function.

      Default: - Default properties are used.

    • getDeadLetterQueueProps

      @Nullable default software.amazon.awscdk.services.sqs.QueueProps getDeadLetterQueueProps()
      Optional user-provided props to override the default props for the dead letter queue.

      Only used if the deployDeadLetterQueue property is set to true.

      Default: - Default props are used.

    • getDeployDeadLetterQueue

      @Nullable default Boolean getDeployDeadLetterQueue()
      Whether to create a secondary queue to be used as a dead letter queue.

      Defaults to true.

      Default: - true.

    • getDeployVpc

      @Nullable default Boolean getDeployVpc()
      Whether to deploy a new VPC.

      Default: - false

    • getExistingConsumerLambdaObj

      @Nullable default software.amazon.awscdk.services.lambda.Function getExistingConsumerLambdaObj()
      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.

      Default: - None.

    • getExistingProducerLambdaObj

      @Nullable default software.amazon.awscdk.services.lambda.Function getExistingProducerLambdaObj()
      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.

      Default: - None.

    • getExistingQueueObj

      @Nullable default software.amazon.awscdk.services.sqs.Queue getExistingQueueObj()
      An optional, existing SQS queue to be used instead of the default queue.

      Providing both this and queueProps will cause an error.

      Default: - None.

    • getExistingVpc

      @Nullable default software.amazon.awscdk.services.ec2.IVpc getExistingVpc()
      An existing VPC for the construct to use (construct will NOT create a new VPC in this case).

    • getMaxReceiveCount

      @Nullable default Number getMaxReceiveCount()
      The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue.

      Defaults to 15.

      Default: - 15.

    • getProducerLambdaFunctionProps

      @Nullable default software.amazon.awscdk.services.lambda.FunctionProps getProducerLambdaFunctionProps()
      Optional user-provided properties to override the default properties for the producer Lambda function.

      Default: - Default properties are used.

    • getQueueEnvironmentVariableName

      @Nullable default String getQueueEnvironmentVariableName()
      Optional Name for the Lambda function environment variable set to the URL of the queue.

      Default: - SQS_QUEUE_URL

    • getQueueProps

      @Nullable default software.amazon.awscdk.services.sqs.QueueProps getQueueProps()
      Optional user-provided properties to override the default properties for the SQS queue.

      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

    • getVpcProps

      @Nullable default software.amazon.awscdk.services.ec2.VpcProps getVpcProps()
      Properties to override default properties if deployVpc is true.

    • builder

      static LambdaToSqsToLambdaProps.Builder builder()
      Returns:
      a LambdaToSqsToLambdaProps.Builder of LambdaToSqsToLambdaProps