Package software.amazon.awsconstructs.services.kinesisstreamslambda

Class KinesisStreamsToLambda.Builder

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

  • Method Details

    • create

      public static KinesisStreamsToLambda.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 KinesisStreamsToLambda.Builder.

    • createCloudWatchAlarms

      public KinesisStreamsToLambda.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)
      Whether to create recommended CloudWatch alarms.

      Default: - Alarms are created

      Parameters:
      createCloudWatchAlarms - Whether to create recommended CloudWatch alarms. This parameter is required.
      Returns:
      this

    • deploySqsDlqQueue

      public KinesisStreamsToLambda.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

    • existingLambdaObj

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

      Default: - None

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

    • existingStreamObj

      public KinesisStreamsToLambda.Builder existingStreamObj(software.amazon.awscdk.services.kinesis.Stream existingStreamObj)
      Existing instance of Kinesis Stream, providing both this and kinesisStreamProps will cause an error.

      Default: - None

      Parameters:
      existingStreamObj - Existing instance of Kinesis Stream, providing both this and kinesisStreamProps will cause an error. This parameter is required.
      Returns:
      this

    • kinesisEventSourceProps

      public KinesisStreamsToLambda.Builder kinesisEventSourceProps(Object kinesisEventSourceProps)
      Optional user-provided props to override the default props for the Lambda event source mapping.

      Default: - Default props are used.

      Parameters:
      kinesisEventSourceProps - Optional user-provided props to override the default props for the Lambda event source mapping. This parameter is required.
      Returns:
      this

    • kinesisStreamProps

      public KinesisStreamsToLambda.Builder kinesisStreamProps(software.amazon.awscdk.services.kinesis.StreamProps kinesisStreamProps)
      Optional user-provided props to override the default props for the Kinesis stream.

      Default: - Default props are used.

      Parameters:
      kinesisStreamProps - Optional user-provided props to override the default props for the Kinesis stream. This parameter is required.
      Returns:
      this

    • lambdaFunctionProps

      public KinesisStreamsToLambda.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)
      User provided props to override the default props for the Lambda function.

      Default: - Default props are used.

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

    • sqsDlqQueueProps

      public KinesisStreamsToLambda.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 KinesisStreamsToLambda build()
      Specified by:
      build in interface software.amazon.jsii.Builder<KinesisStreamsToLambda>
      Returns:
      a newly built instance of KinesisStreamsToLambda.