software.amazon.awsconstructs.services.kinesisstreamslambda

Interface KinesisStreamsToLambdaProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

KinesisStreamsToLambdaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.79.0 (build b22f628)",
           date="2023-03-23T16:43:36.776Z")
public interface KinesisStreamsToLambdaProps
extends software.amazon.jsii.JsiiSerializable

The properties for the KinesisStreamsToLambda class.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	KinesisStreamsToLambdaProps.Builder A builder for KinesisStreamsToLambdaProps
static class	KinesisStreamsToLambdaProps.Jsii$Proxy An implementation for KinesisStreamsToLambdaProps

Method Summary

Modifier and Type	Method and Description
static KinesisStreamsToLambdaProps.Builder	builder()
default Boolean	getCreateCloudWatchAlarms() Whether to create recommended CloudWatch alarms.
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 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.kinesis.Stream	getExistingStreamObj() Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.
default Object	getKinesisEventSourceProps() Optional user-provided props to override the default props for the Lambda event source mapping.
default software.amazon.awscdk.services.kinesis.StreamProps	getKinesisStreamProps() Optional user-provided props to override the default props for the Kinesis stream.
default software.amazon.awscdk.services.lambda.FunctionProps	getLambdaFunctionProps() 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 Detail

getCreateCloudWatchAlarms

@Nullable
default Boolean getCreateCloudWatchAlarms()

Whether to create recommended CloudWatch alarms.

Default: - Alarms are created

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.

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

getExistingStreamObj

@Nullable
default software.amazon.awscdk.services.kinesis.Stream getExistingStreamObj()

Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.

Default: - None

getKinesisEventSourceProps

@Nullable
default Object getKinesisEventSourceProps()

Optional user-provided props to override the default props for the Lambda event source mapping.

Default: - Default props are used.

getKinesisStreamProps

@Nullable
default software.amazon.awscdk.services.kinesis.StreamProps getKinesisStreamProps()

Optional user-provided props to override the default props for the Kinesis stream.

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 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 KinesisStreamsToLambdaProps.Builder builder()

Returns:

a KinesisStreamsToLambdaProps.Builder of KinesisStreamsToLambdaProps