io.cloudshiftdev.awscdk.services.lambda.eventsources.ManagedKafkaEventSource.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.lambda.eventsources
import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.services.kms.IKey
import io.cloudshiftdev.awscdk.services.lambda.IEventSourceDlq
import io.cloudshiftdev.awscdk.services.lambda.IFunction
import io.cloudshiftdev.awscdk.services.lambda.StartingPosition
import io.cloudshiftdev.awscdk.services.secretsmanager.ISecret
import kotlin.Any
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Use a MSK cluster as a streaming source for AWS Lambda.
*
* Example:
*
* ```
* import io.cloudshiftdev.awscdk.services.secretsmanager.Secret;
* import io.cloudshiftdev.awscdk.services.lambda.eventsources.ManagedKafkaEventSource;
* Function myFunction;
* // Your MSK cluster arn
* String clusterArn =
* "arn:aws:kafka:us-east-1:0123456789019:cluster/SalesCluster/abcd1234-abcd-cafe-abab-9876543210ab-4";
* // The Kafka topic you want to subscribe to
* String topic = "some-cool-topic";
* // The secret that allows access to your MSK cluster
* // You still have to make sure that it is associated with your cluster as described in the
* documentation
* Secret secret = Secret.Builder.create(this,
* "Secret").secretName("AmazonMSK_KafkaSecret").build();
* myFunction.addEventSource(ManagedKafkaEventSource.Builder.create()
* .clusterArn(clusterArn)
* .topic(topic)
* .secret(secret)
* .batchSize(100) // default
* .startingPosition(StartingPosition.TRIM_HORIZON)
* .build());
* ```
*/
public open class ManagedKafkaEventSource(
cdkObject: software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource,
) : StreamEventSource(cdkObject) {
public constructor(props: ManagedKafkaEventSourceProps) :
this(software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource(props.let(ManagedKafkaEventSourceProps.Companion::unwrap))
)
public constructor(props: ManagedKafkaEventSourceProps.Builder.() -> Unit) :
this(ManagedKafkaEventSourceProps(props)
)
/**
* Called by `lambda.addEventSource` to allow the event source to bind to this function.
*
* @param target
*/
public override fun bind(target: IFunction) {
unwrap(this).bind(target.let(IFunction.Companion::unwrap))
}
/**
* The ARN for this EventSourceMapping.
*/
public open fun eventSourceMappingArn(): String = unwrap(this).getEventSourceMappingArn()
/**
* The identifier for this EventSourceMapping.
*/
public open fun eventSourceMappingId(): String = unwrap(this).getEventSourceMappingId()
/**
* A fluent builder for
* [io.cloudshiftdev.awscdk.services.lambda.eventsources.ManagedKafkaEventSource].
*/
@CdkDslMarker
public interface Builder {
/**
* The largest number of records that AWS Lambda will retrieve from your event source at the
* time of invoking your function.
*
* Your function receives an
* event with all the retrieved records.
*
* Valid Range:
*
* * Minimum value of 1
* * Maximum value of:
*
* * 1000 for `DynamoEventSource`
* * 10000 for `KinesisEventSource`, `ManagedKafkaEventSource` and `SelfManagedKafkaEventSource`
*
*
* Default: 100
*
* @param batchSize The largest number of records that AWS Lambda will retrieve from your event
* source at the time of invoking your function.
*/
public fun batchSize(batchSize: Number)
/**
* An MSK cluster construct.
*
* @param clusterArn An MSK cluster construct.
*/
public fun clusterArn(clusterArn: String)
/**
* The identifier for the Kafka consumer group to join.
*
* The consumer group ID must be unique among all your Kafka event sources. After creating a
* Kafka event source mapping with the consumer group ID specified, you cannot update this value.
* The value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-/
* *:_+=.@-]*'.
*
* Default: - none
*
* [Documentation](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)
* @param consumerGroupId The identifier for the Kafka consumer group to join.
*/
public fun consumerGroupId(consumerGroupId: String)
/**
* If the stream event source mapping should be enabled.
*
* Default: true
*
* @param enabled If the stream event source mapping should be enabled.
*/
public fun enabled(enabled: Boolean)
/**
* Add Customer managed KMS key to encrypt Filter Criteria.
*
* Default: - none
*
* [Documentation](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)
* @param filterEncryption Add Customer managed KMS key to encrypt Filter Criteria.
*/
public fun filterEncryption(filterEncryption: IKey)
/**
* Add filter criteria to Event Source.
*
* Default: - none
*
* [Documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)
* @param filters Add filter criteria to Event Source.
*/
public fun filters(filters: List>)
/**
* Add filter criteria to Event Source.
*
* Default: - none
*
* [Documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)
* @param filters Add filter criteria to Event Source.
*/
public fun filters(vararg filters: Map)
/**
* The maximum amount of time to gather records before invoking the function.
*
* Maximum of Duration.minutes(5).
*
* Default: - Duration.seconds(0) for Kinesis, DynamoDB, and SQS event sources,
* Duration.millis(500) for MSK, self-managed Kafka, and Amazon MQ.
*
* [Documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching)
* @param maxBatchingWindow The maximum amount of time to gather records before invoking the
* function.
*/
public fun maxBatchingWindow(maxBatchingWindow: Duration)
/**
* Add an on Failure Destination for this Kafka event.
*
* SNS/SQS/S3 are supported
*
* Default: - discarded records are ignored
*
* @param onFailure Add an on Failure Destination for this Kafka event.
*/
public fun onFailure(onFailure: IEventSourceDlq)
/**
* The secret with the Kafka credentials, see
* https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details This field
* is required if your Kafka brokers are accessed over the Internet.
*
* Default: none
*
* @param secret The secret with the Kafka credentials, see
* https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details This field
* is required if your Kafka brokers are accessed over the Internet.
*/
public fun secret(secret: ISecret)
/**
* Where to begin consuming the stream.
*
* @param startingPosition Where to begin consuming the stream.
*/
public fun startingPosition(startingPosition: StartingPosition)
/**
* The Kafka topic to subscribe to.
*
* @param topic The Kafka topic to subscribe to.
*/
public fun topic(topic: String)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource.Builder =
software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource.Builder.create()
/**
* The largest number of records that AWS Lambda will retrieve from your event source at the
* time of invoking your function.
*
* Your function receives an
* event with all the retrieved records.
*
* Valid Range:
*
* * Minimum value of 1
* * Maximum value of:
*
* * 1000 for `DynamoEventSource`
* * 10000 for `KinesisEventSource`, `ManagedKafkaEventSource` and `SelfManagedKafkaEventSource`
*
*
* Default: 100
*
* @param batchSize The largest number of records that AWS Lambda will retrieve from your event
* source at the time of invoking your function.
*/
override fun batchSize(batchSize: Number) {
cdkBuilder.batchSize(batchSize)
}
/**
* An MSK cluster construct.
*
* @param clusterArn An MSK cluster construct.
*/
override fun clusterArn(clusterArn: String) {
cdkBuilder.clusterArn(clusterArn)
}
/**
* The identifier for the Kafka consumer group to join.
*
* The consumer group ID must be unique among all your Kafka event sources. After creating a
* Kafka event source mapping with the consumer group ID specified, you cannot update this value.
* The value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-/
* *:_+=.@-]*'.
*
* Default: - none
*
* [Documentation](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)
* @param consumerGroupId The identifier for the Kafka consumer group to join.
*/
override fun consumerGroupId(consumerGroupId: String) {
cdkBuilder.consumerGroupId(consumerGroupId)
}
/**
* If the stream event source mapping should be enabled.
*
* Default: true
*
* @param enabled If the stream event source mapping should be enabled.
*/
override fun enabled(enabled: Boolean) {
cdkBuilder.enabled(enabled)
}
/**
* Add Customer managed KMS key to encrypt Filter Criteria.
*
* Default: - none
*
* [Documentation](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)
* @param filterEncryption Add Customer managed KMS key to encrypt Filter Criteria.
*/
override fun filterEncryption(filterEncryption: IKey) {
cdkBuilder.filterEncryption(filterEncryption.let(IKey.Companion::unwrap))
}
/**
* Add filter criteria to Event Source.
*
* Default: - none
*
* [Documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)
* @param filters Add filter criteria to Event Source.
*/
override fun filters(filters: List>) {
cdkBuilder.filters(filters)
}
/**
* Add filter criteria to Event Source.
*
* Default: - none
*
* [Documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)
* @param filters Add filter criteria to Event Source.
*/
override fun filters(vararg filters: Map): Unit = filters(filters.toList())
/**
* The maximum amount of time to gather records before invoking the function.
*
* Maximum of Duration.minutes(5).
*
* Default: - Duration.seconds(0) for Kinesis, DynamoDB, and SQS event sources,
* Duration.millis(500) for MSK, self-managed Kafka, and Amazon MQ.
*
* [Documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching)
* @param maxBatchingWindow The maximum amount of time to gather records before invoking the
* function.
*/
override fun maxBatchingWindow(maxBatchingWindow: Duration) {
cdkBuilder.maxBatchingWindow(maxBatchingWindow.let(Duration.Companion::unwrap))
}
/**
* Add an on Failure Destination for this Kafka event.
*
* SNS/SQS/S3 are supported
*
* Default: - discarded records are ignored
*
* @param onFailure Add an on Failure Destination for this Kafka event.
*/
override fun onFailure(onFailure: IEventSourceDlq) {
cdkBuilder.onFailure(onFailure.let(IEventSourceDlq.Companion::unwrap))
}
/**
* The secret with the Kafka credentials, see
* https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details This field
* is required if your Kafka brokers are accessed over the Internet.
*
* Default: none
*
* @param secret The secret with the Kafka credentials, see
* https://docs.aws.amazon.com/msk/latest/developerguide/msk-password.html for details This field
* is required if your Kafka brokers are accessed over the Internet.
*/
override fun secret(secret: ISecret) {
cdkBuilder.secret(secret.let(ISecret.Companion::unwrap))
}
/**
* Where to begin consuming the stream.
*
* @param startingPosition Where to begin consuming the stream.
*/
override fun startingPosition(startingPosition: StartingPosition) {
cdkBuilder.startingPosition(startingPosition.let(StartingPosition.Companion::unwrap))
}
/**
* The Kafka topic to subscribe to.
*
* @param topic The Kafka topic to subscribe to.
*/
override fun topic(topic: String) {
cdkBuilder.topic(topic)
}
public fun build(): software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource
= cdkBuilder.build()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): ManagedKafkaEventSource {
val builderImpl = BuilderImpl()
return ManagedKafkaEventSource(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource):
ManagedKafkaEventSource = ManagedKafkaEventSource(cdkObject)
internal fun unwrap(wrapped: ManagedKafkaEventSource):
software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource =
wrapped.cdkObject as
software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy