Package software.amazon.awsconstructs.services.dynamodbstreamslambda

Interface DynamoDBStreamsToLambdaProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DynamoDBStreamsToLambdaProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-23T22:14:41.986Z") public interface DynamoDBStreamsToLambdaProps extends software.amazon.jsii.JsiiSerializable

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static DynamoDBStreamsToLambdaProps.Builder
    builder()
     
    default Boolean
    getDeploySqsDlqQueue()
    Whether to deploy a SQS dead letter queue when a data record reaches the Maximum Retry Attempts or Maximum Record Age, its metadata like shard ID and stream ARN will be sent to an SQS queue.
    default Object
    getDynamoEventSourceProps()
    Optional user provided props to override the default props.
    default software.amazon.awscdk.services.dynamodb.TableProps
    getDynamoTableProps()
    Optional user provided props to override the default props for the DynamoDB Table.
    default software.amazon.awscdk.services.lambda.Function
    getExistingLambdaObj()
    Optional - instance of an existing Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
    default software.amazon.awscdk.services.dynamodb.ITable
    getExistingTableInterface()
    Optional - existing DynamoDB table, providing both this and dynamoTableProps will cause an error.
    default software.amazon.awscdk.services.lambda.FunctionProps
    getLambdaFunctionProps()
    Optional - user provided props to override the default props for the Lambda function.
    default software.amazon.awscdk.services.sqs.QueueProps
    getSqsDlqQueueProps()
    Optional user provided properties for the SQS dead letter queue.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getDeploySqsDlqQueue

      @Nullable default Boolean getDeploySqsDlqQueue()
      Whether to deploy a SQS dead letter queue when a data record reaches the Maximum Retry Attempts or Maximum Record Age, its metadata like shard ID and stream ARN will be sent to an SQS queue.

      Default: - true.

    • getDynamoEventSourceProps

      @Nullable default Object getDynamoEventSourceProps()
      Optional user provided props to override the default props.

      Default: - Default props are used

    • getDynamoTableProps

      @Nullable default software.amazon.awscdk.services.dynamodb.TableProps getDynamoTableProps()
      Optional user provided props to override the default props for the DynamoDB Table.

      Providing both this and existingTableInterface causes an error.

      Default: - Partition key ID: string

    • getExistingLambdaObj

      @Nullable default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()
      Optional - instance of an existing Lambda Function object, providing both this and lambdaFunctionProps will cause an error.

      Default: - None

    • getExistingTableInterface

      @Nullable default software.amazon.awscdk.services.dynamodb.ITable getExistingTableInterface()
      Optional - existing DynamoDB table, providing both this and dynamoTableProps will cause an error.

      Default: - None

    • getLambdaFunctionProps

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

      Providing both this and existingLambdaObj causes an error.

      Default: - Default props are used

    • getSqsDlqQueueProps

      @Nullable default software.amazon.awscdk.services.sqs.QueueProps getSqsDlqQueueProps()
      Optional user provided properties for the SQS dead letter queue.

      Default: - Default props are used

    • builder

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