Package software.amazon.awscdk.services.lambda

Class EventSourceMappingProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.EventSourceMappingProps.Jsii$Proxy

All Implemented Interfaces:

EventSourceMappingOptions, EventSourceMappingProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

EventSourceMappingProps

@Stability(Stable)
@Internal
public static final class EventSourceMappingProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements EventSourceMappingProps

An implementation for EventSourceMappingProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.EventSourceMappingProps

EventSourceMappingProps.Builder, EventSourceMappingProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(EventSourceMappingProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the EventSourceMappingProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Number	getBatchSize()	The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
final Boolean	getBisectBatchOnError()	If the function returns an error, split the batch in two and retry.
final Boolean	getEnabled()	Set to false to disable the event source upon creation.
final String	getEventSourceArn()	The Amazon Resource Name (ARN) of the event source.
final IKey	getFilterEncryption()	Add Customer managed KMS key to encrypt Filter Criteria.
final List<Map<String,Object>>	getFilters()	Add filter criteria to Event Source.
final List<String>	getKafkaBootstrapServers()	A list of host and port pairs that are the addresses of the Kafka brokers in a self managed "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.
final String	getKafkaConsumerGroupId()	The identifier for the Kafka consumer group to join.
final String	getKafkaTopic()	The name of the Kafka topic.
final Duration	getMaxBatchingWindow()	The maximum amount of time to gather records before invoking the function.
final Number	getMaxConcurrency()	The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke.
final Duration	getMaxRecordAge()	The maximum age of a record that Lambda sends to a function for processing.
final MetricsConfig	getMetricsConfig()	Configuration for enhanced monitoring metrics collection When specified, enables collection of additional metrics for the stream event source.
final IEventSourceDlq	getOnFailure()	An Amazon SQS queue or Amazon SNS topic destination for discarded records.
final Number	getParallelizationFactor()	The number of batches to process from each shard concurrently.
final ProvisionedPollerConfig	getProvisionedPollerConfig()	Configuration for provisioned pollers that read from the event source.
final Boolean	getReportBatchItemFailures()	Allow functions to return partially successful responses for a batch of records.
final Number	getRetryAttempts()	The maximum number of times to retry when the function returns an error.
final List<SourceAccessConfiguration>	getSourceAccessConfigurations()	Specific settings like the authentication protocol or the VPC components to secure access to your event source.
final StartingPosition	getStartingPosition()	The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.
final Number	getStartingPositionTimestamp()	The time from which to start reading, in Unix time seconds.
final Boolean	getSupportS3OnFailureDestination()	Check if support S3 onfailure destination(ODF).
final IFunction	getTarget()	The target AWS Lambda function.
final Duration	getTumblingWindow()	The size of the tumbling windows to group records sent to DynamoDB or Kinesis.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(EventSourceMappingProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the EventSourceMappingProps.Builder.

Method Details

getTarget

public final IFunction getTarget()

Description copied from interface: EventSourceMappingProps

The target AWS Lambda function.

Specified by:

getTarget in interface EventSourceMappingProps

getBatchSize

public final Number getBatchSize()

Description copied from interface: EventSourceMappingOptions

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 10000.

Default: - Amazon Kinesis, Amazon DynamoDB, and Amazon MSK is 100 records. The default for Amazon SQS is 10 messages. For standard SQS queues, the maximum is 10,000. For FIFO SQS queues, the maximum is 10.

Specified by:

getBatchSize in interface EventSourceMappingOptions

getBisectBatchOnError

public final Boolean getBisectBatchOnError()

Description copied from interface: EventSourceMappingOptions

If the function returns an error, split the batch in two and retry.

Default: false

Specified by:

getBisectBatchOnError in interface EventSourceMappingOptions

getEnabled

public final Boolean getEnabled()

Description copied from interface: EventSourceMappingOptions

Set to false to disable the event source upon creation.

Default: true

Specified by:

getEnabled in interface EventSourceMappingOptions

getEventSourceArn

public final String getEventSourceArn()

Description copied from interface: EventSourceMappingOptions

The Amazon Resource Name (ARN) of the event source.

Any record added to this stream can invoke the Lambda function.

Default: - not set if using a self managed Kafka cluster, throws an error otherwise

Specified by:

getEventSourceArn in interface EventSourceMappingOptions

getFilterEncryption

public final IKey getFilterEncryption()

Description copied from interface: EventSourceMappingOptions

Add Customer managed KMS key to encrypt Filter Criteria.

Default: - none

Specified by:

getFilterEncryption in interface EventSourceMappingOptions

See Also:

• https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

getFilters

public final List<Map<String,Object>> getFilters()

Description copied from interface: EventSourceMappingOptions

Add filter criteria to Event Source.

Default: - none

Specified by:

getFilters in interface EventSourceMappingOptions

See Also:

• https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html

getKafkaBootstrapServers

public final List<String> getKafkaBootstrapServers()

Description copied from interface: EventSourceMappingOptions

A list of host and port pairs that are the addresses of the Kafka brokers in a self managed "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.

They are in the format abc.example.com:9096.

Default: - none

Specified by:

getKafkaBootstrapServers in interface EventSourceMappingOptions

getKafkaConsumerGroupId

public final String getKafkaConsumerGroupId()

Description copied from interface: EventSourceMappingOptions

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-/:_+=.@-]'. For more information, see Customizable consumer group ID.

Default: - none

Specified by:

getKafkaConsumerGroupId in interface EventSourceMappingOptions

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html

getKafkaTopic

public final String getKafkaTopic()

Description copied from interface: EventSourceMappingOptions

The name of the Kafka topic.

Default: - no topic

Specified by:

getKafkaTopic in interface EventSourceMappingOptions

getMaxBatchingWindow

public final Duration getMaxBatchingWindow()

Description copied from interface: EventSourceMappingOptions

The maximum amount of time to gather records before invoking the function.

Maximum of Duration.minutes(5)

Default: Duration.seconds(0)

Specified by:

getMaxBatchingWindow in interface EventSourceMappingOptions

getMaxConcurrency

public final Number getMaxConcurrency()

Description copied from interface: EventSourceMappingOptions

The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke.

Default: - No specific limit.

Specified by:

getMaxConcurrency in interface EventSourceMappingOptions

See Also:

• https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency Valid Range: Minimum value of 2. Maximum value of 1000.

getMaxRecordAge

public final Duration getMaxRecordAge()

Description copied from interface: EventSourceMappingOptions

The maximum age of a record that Lambda sends to a function for processing.

Valid Range:

• Minimum value of 60 seconds
• Maximum value of 7 days

Default: - infinite or until the record expires.

Specified by:

getMaxRecordAge in interface EventSourceMappingOptions

getMetricsConfig

public final MetricsConfig getMetricsConfig()

Description copied from interface: EventSourceMappingOptions

Configuration for enhanced monitoring metrics collection When specified, enables collection of additional metrics for the stream event source.

Default: - Enhanced monitoring is disabled

Specified by:

getMetricsConfig in interface EventSourceMappingOptions

getOnFailure

public final IEventSourceDlq getOnFailure()

Description copied from interface: EventSourceMappingOptions

An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Default: discarded records are ignored

Specified by:

getOnFailure in interface EventSourceMappingOptions

getParallelizationFactor

public final Number getParallelizationFactor()

Description copied from interface: EventSourceMappingOptions

The number of batches to process from each shard concurrently.

Valid Range:

• Minimum value of 1
• Maximum value of 10

Default: 1

Specified by:

getParallelizationFactor in interface EventSourceMappingOptions

getProvisionedPollerConfig

public final ProvisionedPollerConfig getProvisionedPollerConfig()

Description copied from interface: EventSourceMappingOptions

Configuration for provisioned pollers that read from the event source.

When specified, allows control over the minimum and maximum number of pollers that can be provisioned to process events from the source.

Default: - no provisioned pollers

Specified by:

getProvisionedPollerConfig in interface EventSourceMappingOptions

getReportBatchItemFailures

public final Boolean getReportBatchItemFailures()

Description copied from interface: EventSourceMappingOptions

Allow functions to return partially successful responses for a batch of records.

Default: false

Specified by:

getReportBatchItemFailures in interface EventSourceMappingOptions

See Also:

• https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting

getRetryAttempts

public final Number getRetryAttempts()

Description copied from interface: EventSourceMappingOptions

The maximum number of times to retry when the function returns an error.

Set to undefined if you want lambda to keep retrying infinitely or until the record expires.

Valid Range:

• Minimum value of 0
• Maximum value of 10000

Default: - infinite or until the record expires.

Specified by:

getRetryAttempts in interface EventSourceMappingOptions

getSourceAccessConfigurations

public final List<SourceAccessConfiguration> getSourceAccessConfigurations()

Description copied from interface: EventSourceMappingOptions

Specific settings like the authentication protocol or the VPC components to secure access to your event source.

Default: - none

Specified by:

getSourceAccessConfigurations in interface EventSourceMappingOptions

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html

getStartingPosition

public final StartingPosition getStartingPosition()

Description copied from interface: EventSourceMappingOptions

The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.

Default: - no starting position

Specified by:

getStartingPosition in interface EventSourceMappingOptions

See Also:

• https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType

getStartingPositionTimestamp

public final Number getStartingPositionTimestamp()

Description copied from interface: EventSourceMappingOptions

The time from which to start reading, in Unix time seconds.

Default: - no timestamp

Specified by:

getStartingPositionTimestamp in interface EventSourceMappingOptions

getSupportS3OnFailureDestination

public final Boolean getSupportS3OnFailureDestination()

Description copied from interface: EventSourceMappingOptions

Check if support S3 onfailure destination(ODF).

Currently only MSK and self managed kafka event support S3 ODF

Default: false

Specified by:

getSupportS3OnFailureDestination in interface EventSourceMappingOptions

getTumblingWindow

public final Duration getTumblingWindow()

Description copied from interface: EventSourceMappingOptions

The size of the tumbling windows to group records sent to DynamoDB or Kinesis.

Default: - None

Specified by:

getTumblingWindow in interface EventSourceMappingOptions

See Also:

• https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows Valid Range: 0 - 15 minutes

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object