Package com.pulumi.aws.lambda

Class EventSourceMappingArgs

  • public final class EventSourceMappingArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • amazonManagedKafkaEventSourceConfig

        public java.util.Optional<com.pulumi.core.Output<EventSourceMappingAmazonManagedKafkaEventSourceConfigArgs>> amazonManagedKafkaEventSourceConfig()
        Returns:
        Additional configuration block for Amazon Managed Kafka sources. Incompatible with `selfManagedEventSource` and `selfManagedKafkaEventSourceConfig`. See below.

      • batchSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> batchSize()
        Returns:
        Largest number of records that Lambda will retrieve from your event source at the time of invocation. Defaults to `100` for DynamoDB, Kinesis, MQ and MSK, `10` for SQS.

      • bisectBatchOnFunctionError

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> bisectBatchOnFunctionError()
        Returns:
        Whether to split the batch in two and retry if the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Defaults to `false`.

      • destinationConfig

        public java.util.Optional<com.pulumi.core.Output<EventSourceMappingDestinationConfigArgs>> destinationConfig()
        Returns:
        Amazon SQS queue, Amazon SNS topic or Amazon S3 bucket (only available for Kafka sources) destination for failed records. Only available for stream sources (DynamoDB and Kinesis) and Kafka sources (Amazon MSK and Self-managed Apache Kafka). See below.

      • enabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enabled()
        Returns:
        Whether the mapping is enabled. Defaults to `true`.

      • eventSourceArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> eventSourceArn()
        Returns:
        Event source ARN - required for Kinesis stream, DynamoDB stream, SQS queue, MQ broker, MSK cluster or DocumentDB change stream. Incompatible with Self Managed Kafka source.

      • filterCriteria

        public java.util.Optional<com.pulumi.core.Output<EventSourceMappingFilterCriteriaArgs>> filterCriteria()
        Returns:
        Criteria to use for [event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) Kinesis stream, DynamoDB stream, SQS queue event sources. See below.

      • functionName

        public com.pulumi.core.Output<java.lang.String> functionName()
        Returns:
        Name or ARN of the Lambda function that will be subscribing to events. The following arguments are optional:

      • functionResponseTypes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> functionResponseTypes()
        Returns:
        List of current response type enums applied to the event source mapping for [AWS Lambda checkpointing](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting). Only available for SQS and stream sources (DynamoDB and Kinesis). Valid values: `ReportBatchItemFailures`.

      • kmsKeyArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()
        Returns:
        ARN of the KMS customer managed key that Lambda uses to encrypt your function's filter criteria.

      • maximumBatchingWindowInSeconds

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maximumBatchingWindowInSeconds()
        Returns:
        Maximum amount of time to gather records before invoking the function, in seconds (between 0 and 300). Records will continue to buffer until either `maximumBatchingWindowInSeconds` expires or `batchSize` has been met. For streaming event sources, defaults to as soon as records are available in the stream. Only available for stream sources (DynamoDB and Kinesis) and SQS standard queues.

      • maximumRecordAgeInSeconds

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maximumRecordAgeInSeconds()
        Returns:
        Maximum age of a record that Lambda sends to a function for processing. Only available for stream sources (DynamoDB and Kinesis). Must be either -1 (forever, and the default value) or between 60 and 604800 (inclusive).

      • maximumRetryAttempts

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maximumRetryAttempts()
        Returns:
        Maximum number of times to retry when the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of -1 (forever), maximum of 10000.

      • metricsConfig

        public java.util.Optional<com.pulumi.core.Output<EventSourceMappingMetricsConfigArgs>> metricsConfig()
        Returns:
        CloudWatch metrics configuration of the event source. Only available for stream sources (DynamoDB and Kinesis) and SQS queues. See below.

      • parallelizationFactor

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> parallelizationFactor()
        Returns:
        Number of batches to process from each shard concurrently. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of 1, maximum of 10.

      • provisionedPollerConfig

        public java.util.Optional<com.pulumi.core.Output<EventSourceMappingProvisionedPollerConfigArgs>> provisionedPollerConfig()
        Returns:
        Event poller configuration for the event source. Only valid for Amazon MSK or self-managed Apache Kafka sources. See below.

      • queues

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> queues()
        Returns:
        Name of the Amazon MQ broker destination queue to consume. Only available for MQ sources. The list must contain exactly one queue name.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • scalingConfig

        public java.util.Optional<com.pulumi.core.Output<EventSourceMappingScalingConfigArgs>> scalingConfig()
        Returns:
        Scaling configuration of the event source. Only available for SQS queues. See below.

      • selfManagedEventSource

        public java.util.Optional<com.pulumi.core.Output<EventSourceMappingSelfManagedEventSourceArgs>> selfManagedEventSource()
        Returns:
        For Self Managed Kafka sources, the location of the self managed cluster. If set, configuration must also include `sourceAccessConfiguration`. See below.

      • selfManagedKafkaEventSourceConfig

        public java.util.Optional<com.pulumi.core.Output<EventSourceMappingSelfManagedKafkaEventSourceConfigArgs>> selfManagedKafkaEventSourceConfig()
        Returns:
        Additional configuration block for Self Managed Kafka sources. Incompatible with `eventSourceArn` and `amazonManagedKafkaEventSourceConfig`. See below.

      • sourceAccessConfigurations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<EventSourceMappingSourceAccessConfigurationArgs>>> sourceAccessConfigurations()
        Returns:
        For Self Managed Kafka sources, the access configuration for the source. If set, configuration must also include `selfManagedEventSource`. See below.

      • startingPosition

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> startingPosition()
        Returns:
        Position in the stream where AWS Lambda should start reading. Must be one of `AT_TIMESTAMP` (Kinesis only), `LATEST` or `TRIM_HORIZON` if getting events from Kinesis, DynamoDB, MSK or Self Managed Apache Kafka. Must not be provided if getting events from SQS. More information about these positions can be found in the [AWS DynamoDB Streams API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetShardIterator.html) and [AWS Kinesis API Reference](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType).

      • startingPositionTimestamp

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> startingPositionTimestamp()
        Returns:
        Timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of the data record which to start reading when using `startingPosition` set to `AT_TIMESTAMP`. If a record with this exact timestamp does not exist, the next later record is chosen. If the timestamp is older than the current trim horizon, the oldest available record is chosen.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the object. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • topics

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> topics()
        Returns:
        Name of the Kafka topics. Only available for MSK sources. A single topic name must be specified.

      • tumblingWindowInSeconds

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> tumblingWindowInSeconds()
        Returns:
        Duration in seconds of a processing window for [AWS Lambda streaming analytics](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows). The range is between 1 second up to 900 seconds. Only available for stream sources (DynamoDB and Kinesis).

      • useResourceTimeoutForPropagation

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> useResourceTimeoutForPropagation()
        Returns:
        Whether to apply resource level timeout values while retrying eventually consistent API operations. By default the provider uses a 5 minute timeout to allow for propagation in the Lambda service. When set to `true`, this default value is replaced with the configurable resource timeouts. Increased timeout values may be useful in highly active accounts, or regions where propagation delays are inconsistent.