Package software.amazon.awscdk.services.lambda

Class CfnEventSourceMappingProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnEventSourceMappingProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEventSourceMappingProps

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

An implementation for CfnEventSourceMappingProps

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

CfnEventSourceMappingProps.Builder, CfnEventSourceMappingProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEventSourceMappingProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEventSourceMappingProps.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 Object	getAmazonManagedKafkaEventSourceConfig()	Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
final Number	getBatchSize()	The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
final Object	getBisectBatchOnFunctionError()	(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
final Object	getDestinationConfig()	(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
final Object	getDocumentDbEventSourceConfig()	Specific configuration settings for a DocumentDB event source.
final Object	getEnabled()	When true, the event source mapping is active.
final String	getEventSourceArn()	The Amazon Resource Name (ARN) of the event source.
final Object	getFilterCriteria()	An object that defines the filter criteria that determine whether Lambda should process an event.
final String	getFunctionName()	The name or ARN of the Lambda function.
final List<String>	getFunctionResponseTypes()	(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
final String	getKmsKeyArn()	The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's filter criteria .
final Number	getMaximumBatchingWindowInSeconds()	The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
final Number	getMaximumRecordAgeInSeconds()	(Kinesis and DynamoDB Streams only) Discard records older than the specified age.
final Number	getMaximumRetryAttempts()	(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.
final Object	getMetricsConfig()	The metrics configuration for your event source.
final Number	getParallelizationFactor()	(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.
final Object	getProvisionedPollerConfig()	(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.
final List<String>	getQueues()	(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
final Object	getScalingConfig()	(Amazon SQS only) The scaling configuration for the event source.
final Object	getSelfManagedEventSource()	The self-managed Apache Kafka cluster for your event source.
final Object	getSelfManagedKafkaEventSourceConfig()	Specific configuration settings for a self-managed Apache Kafka event source.
final Object	getSourceAccessConfigurations()	An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
final String	getStartingPosition()	The position in a stream from which to start reading.
final Number	getStartingPositionTimestamp()	With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.
final List<CfnTag>	getTags()	A list of tags to add to the event source mapping.
final List<String>	getTopics()	The name of the Kafka topic.
final Number	getTumblingWindowInSeconds()	(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.
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(CfnEventSourceMappingProps.Builder builder)

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

Method Details

getFunctionName

public final String getFunctionName()

Description copied from interface: CfnEventSourceMappingProps

The name or ARN of the Lambda function.

Name formats - Function name – MyFunction .

• Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction .
• Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD .
• Partial ARN – 123456789012:function:MyFunction .

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

Specified by:

getFunctionName in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname

getAmazonManagedKafkaEventSourceConfig

public final Object getAmazonManagedKafkaEventSourceConfig()

Description copied from interface: CfnEventSourceMappingProps

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

Returns union: either IResolvable or CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty

Specified by:

getAmazonManagedKafkaEventSourceConfig in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig

getBatchSize

public final Number getBatchSize()

Description copied from interface: CfnEventSourceMappingProps

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.

Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

• Amazon Kinesis – Default 100. Max 10,000.
• Amazon DynamoDB Streams – Default 100. Max 10,000.
• Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
• Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
• Self-managed Apache Kafka – Default 100. Max 10,000.
• Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
• DocumentDB – Default 100. Max 10,000.

Specified by:

getBatchSize in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize

getBisectBatchOnFunctionError

public final Object getBisectBatchOnFunctionError()

Description copied from interface: CfnEventSourceMappingProps

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

The default value is false.

When using BisectBatchOnFunctionError , check the BatchSize parameter in the OnFailure destination message's metadata. The BatchSize could be greater than 1 since Lambda consolidates failed messages metadata when writing to the OnFailure destination.

Returns union: either Boolean or IResolvable

Specified by:

getBisectBatchOnFunctionError in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror

getDestinationConfig

public final Object getDestinationConfig()

Description copied from interface: CfnEventSourceMappingProps

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

Returns union: either IResolvable or CfnEventSourceMapping.DestinationConfigProperty

Specified by:

getDestinationConfig in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig

getDocumentDbEventSourceConfig

public final Object getDocumentDbEventSourceConfig()

Description copied from interface: CfnEventSourceMappingProps

Specific configuration settings for a DocumentDB event source.

Returns union: either IResolvable or CfnEventSourceMapping.DocumentDBEventSourceConfigProperty

Specified by:

getDocumentDbEventSourceConfig in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig

getEnabled

public final Object getEnabled()

Description copied from interface: CfnEventSourceMappingProps

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

Returns union: either Boolean or IResolvable

Specified by:

getEnabled in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled

getEventSourceArn

public final String getEventSourceArn()

Description copied from interface: CfnEventSourceMappingProps

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

• Amazon Kinesis – The ARN of the data stream or a stream consumer.
• Amazon DynamoDB Streams – The ARN of the stream.
• Amazon Simple Queue Service – The ARN of the queue.
• Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings ).
• Amazon MQ – The ARN of the broker.
• Amazon DocumentDB – The ARN of the DocumentDB change stream.

Specified by:

getEventSourceArn in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn

getFilterCriteria

public final Object getFilterCriteria()

Description copied from interface: CfnEventSourceMappingProps

An object that defines the filter criteria that determine whether Lambda should process an event.

For more information, see Lambda event filtering .

Returns union: either IResolvable or CfnEventSourceMapping.FilterCriteriaProperty

Specified by:

getFilterCriteria in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria

getFunctionResponseTypes

public final List<String> getFunctionResponseTypes()

Description copied from interface: CfnEventSourceMappingProps

(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.

Valid Values: ReportBatchItemFailures

Specified by:

getFunctionResponseTypes in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes

getKmsKeyArn

public final String getKmsKeyArn()

Description copied from interface: CfnEventSourceMappingProps

The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's filter criteria .

Specified by:

getKmsKeyArn in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn

getMaximumBatchingWindowInSeconds

public final Number getMaximumBatchingWindowInSeconds()

Description copied from interface: CfnEventSourceMappingProps

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

Default ( Kinesis , DynamoDB , Amazon SQS event sources) : 0

Default ( Amazon MSK , Kafka, Amazon MQ , Amazon DocumentDB event sources) : 500 ms

Related setting: For Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Specified by:

getMaximumBatchingWindowInSeconds in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds

getMaximumRecordAgeInSeconds

public final Number getMaximumRecordAgeInSeconds()

Description copied from interface: CfnEventSourceMappingProps

(Kinesis and DynamoDB Streams only) Discard records older than the specified age.

The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

Specified by:

getMaximumRecordAgeInSeconds in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds

getMaximumRetryAttempts

public final Number getMaximumRetryAttempts()

Description copied from interface: CfnEventSourceMappingProps

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.

The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

Specified by:

getMaximumRetryAttempts in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts

getMetricsConfig

public final Object getMetricsConfig()

Description copied from interface: CfnEventSourceMappingProps

The metrics configuration for your event source.

For more information, see Event source mapping metrics .

Returns union: either IResolvable or CfnEventSourceMapping.MetricsConfigProperty

Specified by:

getMetricsConfig in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig

getParallelizationFactor

public final Number getParallelizationFactor()

Description copied from interface: CfnEventSourceMappingProps

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.

The default value is 1.

Specified by:

getParallelizationFactor in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor

getProvisionedPollerConfig

public final Object getProvisionedPollerConfig()

Description copied from interface: CfnEventSourceMappingProps

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.

For more information, see provisioned mode .

Returns union: either IResolvable or CfnEventSourceMapping.ProvisionedPollerConfigProperty

Specified by:

getProvisionedPollerConfig in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig

getQueues

public final List<String> getQueues()

Description copied from interface: CfnEventSourceMappingProps

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

Specified by:

getQueues in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues

getScalingConfig

public final Object getScalingConfig()

Description copied from interface: CfnEventSourceMappingProps

(Amazon SQS only) The scaling configuration for the event source.

For more information, see Configuring maximum concurrency for Amazon SQS event sources .

Returns union: either IResolvable or CfnEventSourceMapping.ScalingConfigProperty

Specified by:

getScalingConfig in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-scalingconfig

getSelfManagedEventSource

public final Object getSelfManagedEventSource()

Description copied from interface: CfnEventSourceMappingProps

The self-managed Apache Kafka cluster for your event source.

Returns union: either IResolvable or CfnEventSourceMapping.SelfManagedEventSourceProperty

Specified by:

getSelfManagedEventSource in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource

getSelfManagedKafkaEventSourceConfig

public final Object getSelfManagedKafkaEventSourceConfig()

Description copied from interface: CfnEventSourceMappingProps

Specific configuration settings for a self-managed Apache Kafka event source.

Returns union: either IResolvable or CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty

Specified by:

getSelfManagedKafkaEventSourceConfig in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig

getSourceAccessConfigurations

public final Object getSourceAccessConfigurations()

Description copied from interface: CfnEventSourceMappingProps

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEventSourceMapping.SourceAccessConfigurationProperty>

Specified by:

getSourceAccessConfigurations in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations

getStartingPosition

public final String getStartingPosition()

Description copied from interface: CfnEventSourceMappingProps

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.

• LATEST - Read only new records.
• TRIM_HORIZON - Process all available records.
• AT_TIMESTAMP - Specify a time from which to start reading records.

Specified by:

getStartingPosition in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition

getStartingPositionTimestamp

public final Number getStartingPositionTimestamp()

Description copied from interface: CfnEventSourceMappingProps

With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

StartingPositionTimestamp cannot be in the future.

Specified by:

getStartingPositionTimestamp in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnEventSourceMappingProps

A list of tags to add to the event source mapping.

You must have the lambda:TagResource , lambda:UntagResource , and lambda:ListTags permissions for your IAM principal to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.

Specified by:

getTags in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tags

getTopics

public final List<String> getTopics()

Description copied from interface: CfnEventSourceMappingProps

The name of the Kafka topic.

Specified by:

getTopics in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics

getTumblingWindowInSeconds

public final Number getTumblingWindowInSeconds()

Description copied from interface: CfnEventSourceMappingProps

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

A value of 0 seconds indicates no tumbling window.

Specified by:

getTumblingWindowInSeconds in interface CfnEventSourceMappingProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds

$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