Class CfnEventSourceMappingProps.Jsii$Proxy
- All Implemented Interfaces:
CfnEventSourceMappingProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- CfnEventSourceMappingProps
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
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnEventSourceMappingProps.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.final Number
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.final Object
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.final Object
(Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.final Object
Specific configuration settings for a DocumentDB event source.final Object
When true, the event source mapping is active.final String
The Amazon Resource Name (ARN) of the event source.final Object
An object that defines the filter criteria that determine whether Lambda should process an event.final String
The name of the Lambda function.(Streams and SQS) A list of current response type enums applied to the event source mapping.final Number
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.final Number
(Kinesis and DynamoDB Streams only) Discard records older than the specified age.final Number
(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.final Number
(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.final Object
(Amazon SQS only) The scaling configuration for the event source.final Object
The self-managed Apache Kafka cluster for your event source.final Object
Specific configuration settings for a self-managed Apache Kafka event source.final Object
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.final String
The position in a stream from which to start reading.final Number
WithStartingPosition
set toAT_TIMESTAMP
, the time from which to start reading, in Unix time seconds.The name of the Kafka topic.final Number
(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
-
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
Constructor that initializes the object based on literal property values passed by theCfnEventSourceMappingProps.Builder
.
-
-
Method Details
-
getFunctionName
Description copied from interface:CfnEventSourceMappingProps
The name 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 interfaceCfnEventSourceMappingProps
- Function ARN –
-
getAmazonManagedKafkaEventSourceConfig
Description copied from interface:CfnEventSourceMappingProps
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.- Specified by:
getAmazonManagedKafkaEventSourceConfig
in interfaceCfnEventSourceMappingProps
-
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 interfaceCfnEventSourceMappingProps
-
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.
- Specified by:
getBisectBatchOnFunctionError
in interfaceCfnEventSourceMappingProps
-
getDestinationConfig
Description copied from interface:CfnEventSourceMappingProps
(Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.- Specified by:
getDestinationConfig
in interfaceCfnEventSourceMappingProps
-
getDocumentDbEventSourceConfig
Description copied from interface:CfnEventSourceMappingProps
Specific configuration settings for a DocumentDB event source.- Specified by:
getDocumentDbEventSourceConfig
in interfaceCfnEventSourceMappingProps
-
getEnabled
Description copied from interface:CfnEventSourceMappingProps
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.Default: True
- Specified by:
getEnabled
in interfaceCfnEventSourceMappingProps
-
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.
- Amazon MQ – The ARN of the broker.
- Amazon DocumentDB – The ARN of the DocumentDB change stream.
- Specified by:
getEventSourceArn
in interfaceCfnEventSourceMappingProps
-
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 .
- Specified by:
getFilterCriteria
in interfaceCfnEventSourceMappingProps
-
getFunctionResponseTypes
Description copied from interface:CfnEventSourceMappingProps
(Streams and SQS) A list of current response type enums applied to the event source mapping.Valid Values:
ReportBatchItemFailures
- Specified by:
getFunctionResponseTypes
in interfaceCfnEventSourceMappingProps
-
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 setMaximumBatchingWindowInSeconds
to at least 1.- Specified by:
getMaximumBatchingWindowInSeconds
in interfaceCfnEventSourceMappingProps
-
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 interfaceCfnEventSourceMappingProps
-
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 interfaceCfnEventSourceMappingProps
-
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 interfaceCfnEventSourceMappingProps
-
getQueues
Description copied from interface:CfnEventSourceMappingProps
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.- Specified by:
getQueues
in interfaceCfnEventSourceMappingProps
-
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 .
- Specified by:
getScalingConfig
in interfaceCfnEventSourceMappingProps
-
getSelfManagedEventSource
Description copied from interface:CfnEventSourceMappingProps
The self-managed Apache Kafka cluster for your event source.- Specified by:
getSelfManagedEventSource
in interfaceCfnEventSourceMappingProps
-
getSelfManagedKafkaEventSourceConfig
Description copied from interface:CfnEventSourceMappingProps
Specific configuration settings for a self-managed Apache Kafka event source.- Specified by:
getSelfManagedKafkaEventSourceConfig
in interfaceCfnEventSourceMappingProps
-
getSourceAccessConfigurations
Description copied from interface:CfnEventSourceMappingProps
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.- Specified by:
getSourceAccessConfigurations
in interfaceCfnEventSourceMappingProps
-
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 interfaceCfnEventSourceMappingProps
-
getStartingPositionTimestamp
Description copied from interface:CfnEventSourceMappingProps
WithStartingPosition
set toAT_TIMESTAMP
, the time from which to start reading, in Unix time seconds.- Specified by:
getStartingPositionTimestamp
in interfaceCfnEventSourceMappingProps
-
getTopics
Description copied from interface:CfnEventSourceMappingProps
The name of the Kafka topic.- Specified by:
getTopics
in interfaceCfnEventSourceMappingProps
-
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 interfaceCfnEventSourceMappingProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-