Package software.amazon.awsconstructs.services.dynamodbstreamslambda

Class DynamoDBStreamsToLambda.Builder

java.lang.Object
software.amazon.awsconstructs.services.dynamodbstreamslambda.DynamoDBStreamsToLambda.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<DynamoDBStreamsToLambda>
Enclosing class:
DynamoDBStreamsToLambda
public static final class DynamoDBStreamsToLambda.Builder extends Object implements software.amazon.jsii.Builder<DynamoDBStreamsToLambda>
A fluent builder for DynamoDBStreamsToLambda.

  • Method Details

    • create

      public static DynamoDBStreamsToLambda.Builder create(software.constructs.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 DynamoDBStreamsToLambda.Builder.

    • deploySqsDlqQueue

      public DynamoDBStreamsToLambda.Builder deploySqsDlqQueue(Boolean deploySqsDlqQueue)
      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.

      Parameters:
      deploySqsDlqQueue - 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. This parameter is required.
      Returns:
      this

    • dynamoEventSourceProps

      public DynamoDBStreamsToLambda.Builder dynamoEventSourceProps(Object dynamoEventSourceProps)
      Optional user provided props to override the default props.

      Default: - Default props are used

      Parameters:
      dynamoEventSourceProps - Optional user provided props to override the default props. This parameter is required.
      Returns:
      this

    • dynamoTableProps

      public DynamoDBStreamsToLambda.Builder dynamoTableProps(software.amazon.awscdk.services.dynamodb.TableProps dynamoTableProps)
      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

      Parameters:
      dynamoTableProps - Optional user provided props to override the default props for the DynamoDB Table. This parameter is required.
      Returns:
      this

    • existingLambdaObj

      public DynamoDBStreamsToLambda.Builder existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)
      Optional - instance of an existing Lambda Function object, providing both this and lambdaFunctionProps will cause an error.

      Default: - None

      Parameters:
      existingLambdaObj - Optional - instance of an existing Lambda Function object, providing both this and lambdaFunctionProps will cause an error. This parameter is required.
      Returns:
      this

    • existingTableInterface

      public DynamoDBStreamsToLambda.Builder existingTableInterface(software.amazon.awscdk.services.dynamodb.ITable existingTableInterface)
      Optional - existing DynamoDB table, providing both this and dynamoTableProps will cause an error.

      Default: - None

      Parameters:
      existingTableInterface - Optional - existing DynamoDB table, providing both this and dynamoTableProps will cause an error. This parameter is required.
      Returns:
      this

    • lambdaFunctionProps

      public DynamoDBStreamsToLambda.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)
      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

      Parameters:
      lambdaFunctionProps - Optional - user provided props to override the default props for the Lambda function. This parameter is required.
      Returns:
      this

    • sqsDlqQueueProps

      public DynamoDBStreamsToLambda.Builder sqsDlqQueueProps(software.amazon.awscdk.services.sqs.QueueProps sqsDlqQueueProps)
      Optional user provided properties for the SQS dead letter queue.

      Default: - Default props are used

      Parameters:
      sqsDlqQueueProps - Optional user provided properties for the SQS dead letter queue. This parameter is required.
      Returns:
      this

    • build

      public DynamoDBStreamsToLambda build()
      Specified by:
      build in interface software.amazon.jsii.Builder<DynamoDBStreamsToLambda>
      Returns:
      a newly built instance of DynamoDBStreamsToLambda.