Package 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.109.0 (build c221850)", date="2025-03-11T21:33:41.268Z") public interface SqsToLambdaProps extends software.amazon.jsii.JsiiSerializable

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    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 Boolean
    getEnableEncryptionWithCustomerManagedKey()
    If no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key.
    default software.amazon.awscdk.services.kms.Key
    getEncryptionKey()
    An optional, imported encryption key to encrypt the SQS queue with.
    default software.amazon.awscdk.services.kms.KeyProps
    getEncryptionKeyProps()
    Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.
    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 Details

    • 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.

    • getEnableEncryptionWithCustomerManagedKey

      @Nullable default Boolean getEnableEncryptionWithCustomerManagedKey()
      If no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key.

      This flag is ignored if any of the following are defined: queueProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.

      Default: - False if queueProps.encryptionMasterKey, encryptionKey, and encryptionKeyProps are all undefined.

    • getEncryptionKey

      @Nullable default software.amazon.awscdk.services.kms.Key getEncryptionKey()
      An optional, imported encryption key to encrypt the SQS queue with.

      Default: - None

    • getEncryptionKeyProps

      @Nullable default software.amazon.awscdk.services.kms.KeyProps getEncryptionKeyProps()
      Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.

      Default: - None

    • 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