AWS Native
EventSourceMapping
Resource Type definition for AWS::Lambda::EventSourceMapping
Create a EventSourceMapping Resource
new EventSourceMapping(name: string, args: EventSourceMappingArgs, opts?: CustomResourceOptions);
@overload
def EventSourceMapping(resource_name: str,
opts: Optional[ResourceOptions] = None,
batch_size: Optional[int] = None,
bisect_batch_on_function_error: Optional[bool] = None,
destination_config: Optional[_lambda_.EventSourceMappingDestinationConfigArgs] = None,
enabled: Optional[bool] = None,
event_source_arn: Optional[str] = None,
filter_criteria: Optional[_lambda_.EventSourceMappingFilterCriteriaArgs] = None,
function_name: Optional[str] = None,
function_response_types: Optional[Sequence[_lambda_.EventSourceMappingFunctionResponseTypesItem]] = None,
maximum_batching_window_in_seconds: Optional[int] = None,
maximum_record_age_in_seconds: Optional[int] = None,
maximum_retry_attempts: Optional[int] = None,
parallelization_factor: Optional[int] = None,
queues: Optional[Sequence[str]] = None,
self_managed_event_source: Optional[_lambda_.EventSourceMappingSelfManagedEventSourceArgs] = None,
source_access_configurations: Optional[Sequence[_lambda_.EventSourceMappingSourceAccessConfigurationArgs]] = None,
starting_position: Optional[str] = None,
starting_position_timestamp: Optional[float] = None,
topics: Optional[Sequence[str]] = None,
tumbling_window_in_seconds: Optional[int] = None)
@overload
def EventSourceMapping(resource_name: str,
args: EventSourceMappingArgs,
opts: Optional[ResourceOptions] = None)
func NewEventSourceMapping(ctx *Context, name string, args EventSourceMappingArgs, opts ...ResourceOption) (*EventSourceMapping, error)
public EventSourceMapping(string name, EventSourceMappingArgs args, CustomResourceOptions? opts = null)
public EventSourceMapping(String name, EventSourceMappingArgs args)
public EventSourceMapping(String name, EventSourceMappingArgs args, CustomResourceOptions options)
type: aws-native:lambda:EventSourceMapping
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EventSourceMappingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EventSourceMappingArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EventSourceMappingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EventSourceMappingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EventSourceMappingArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
EventSourceMapping Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The EventSourceMapping resource accepts the following input properties:
- Function
Name string The name of the Lambda function.
- Batch
Size int The maximum number of items to retrieve in a single batch.
- Bisect
Batch boolOn Function Error (Streams) If the function returns an error, split the batch in two and retry.
- Destination
Config Pulumi.Aws Native. Lambda. Inputs. Event Source Mapping Destination Config Args (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- Enabled bool
Disables the event source mapping to pause polling and invocation.
- Event
Source stringArn The Amazon Resource Name (ARN) of the event source.
- Filter
Criteria Pulumi.Aws Native. Lambda. Inputs. Event Source Mapping Filter Criteria Args The filter criteria to control event filtering.
- Function
Response List<Pulumi.Types Aws Native. Lambda. Event Source Mapping Function Response Types Item> (Streams) A list of response types supported by the function.
- Maximum
Batching intWindow In Seconds (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
- Maximum
Record intAge In Seconds (Streams) The maximum age of a record that Lambda sends to a function for processing.
- Maximum
Retry intAttempts (Streams) The maximum number of times to retry when the function returns an error.
- Parallelization
Factor int (Streams) The number of batches to process from each shard concurrently.
- Queues List<string>
(ActiveMQ) A list of ActiveMQ queues.
- Self
Managed Pulumi.Event Source Aws Native. Lambda. Inputs. Event Source Mapping Self Managed Event Source Args Self-managed event source endpoints.
- Source
Access List<Pulumi.Configurations Aws Native. Lambda. Inputs. Event Source Mapping Source Access Configuration Args> A list of SourceAccessConfiguration.
- Starting
Position string The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
- Starting
Position doubleTimestamp With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
- Topics List<string>
(Kafka) A list of Kafka topics.
- Tumbling
Window intIn Seconds (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
- Function
Name string The name of the Lambda function.
- Batch
Size int The maximum number of items to retrieve in a single batch.
- Bisect
Batch boolOn Function Error (Streams) If the function returns an error, split the batch in two and retry.
- Destination
Config EventSource Mapping Destination Config Args (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- Enabled bool
Disables the event source mapping to pause polling and invocation.
- Event
Source stringArn The Amazon Resource Name (ARN) of the event source.
- Filter
Criteria EventSource Mapping Filter Criteria Args The filter criteria to control event filtering.
- Function
Response []EventTypes Source Mapping Function Response Types Item (Streams) A list of response types supported by the function.
- Maximum
Batching intWindow In Seconds (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
- Maximum
Record intAge In Seconds (Streams) The maximum age of a record that Lambda sends to a function for processing.
- Maximum
Retry intAttempts (Streams) The maximum number of times to retry when the function returns an error.
- Parallelization
Factor int (Streams) The number of batches to process from each shard concurrently.
- Queues []string
(ActiveMQ) A list of ActiveMQ queues.
- Self
Managed EventEvent Source Source Mapping Self Managed Event Source Args Self-managed event source endpoints.
- Source
Access []EventConfigurations Source Mapping Source Access Configuration Args A list of SourceAccessConfiguration.
- Starting
Position string The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
- Starting
Position float64Timestamp With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
- Topics []string
(Kafka) A list of Kafka topics.
- Tumbling
Window intIn Seconds (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
- function
Name String The name of the Lambda function.
- batch
Size Integer The maximum number of items to retrieve in a single batch.
- bisect
Batch BooleanOn Function Error (Streams) If the function returns an error, split the batch in two and retry.
- destination
Config EventSource Mapping Destination Config Args (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- enabled Boolean
Disables the event source mapping to pause polling and invocation.
- event
Source StringArn The Amazon Resource Name (ARN) of the event source.
- filter
Criteria EventSource Mapping Filter Criteria Args The filter criteria to control event filtering.
- function
Response ListTypes Source Mapping Function Response Types Item> (Streams) A list of response types supported by the function.
- maximum
Batching IntegerWindow In Seconds (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
- maximum
Record IntegerAge In Seconds (Streams) The maximum age of a record that Lambda sends to a function for processing.
- maximum
Retry IntegerAttempts (Streams) The maximum number of times to retry when the function returns an error.
- parallelization
Factor Integer (Streams) The number of batches to process from each shard concurrently.
- queues
List
(ActiveMQ) A list of ActiveMQ queues.
- self
Managed EventEvent Source Source Mapping Self Managed Event Source Args Self-managed event source endpoints.
- source
Access ListConfigurations Source Mapping Source Access Configuration Args> A list of SourceAccessConfiguration.
- starting
Position String The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
- starting
Position DoubleTimestamp With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
- topics
List
(Kafka) A list of Kafka topics.
- tumbling
Window IntegerIn Seconds (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
- function
Name string The name of the Lambda function.
- batch
Size number The maximum number of items to retrieve in a single batch.
- bisect
Batch booleanOn Function Error (Streams) If the function returns an error, split the batch in two and retry.
- destination
Config EventSource Mapping Destination Config Args (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- enabled boolean
Disables the event source mapping to pause polling and invocation.
- event
Source stringArn The Amazon Resource Name (ARN) of the event source.
- filter
Criteria EventSource Mapping Filter Criteria Args The filter criteria to control event filtering.
- function
Response EventTypes Source Mapping Function Response Types Item[] (Streams) A list of response types supported by the function.
- maximum
Batching numberWindow In Seconds (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
- maximum
Record numberAge In Seconds (Streams) The maximum age of a record that Lambda sends to a function for processing.
- maximum
Retry numberAttempts (Streams) The maximum number of times to retry when the function returns an error.
- parallelization
Factor number (Streams) The number of batches to process from each shard concurrently.
- queues string[]
(ActiveMQ) A list of ActiveMQ queues.
- self
Managed EventEvent Source Source Mapping Self Managed Event Source Args Self-managed event source endpoints.
- source
Access EventConfigurations Source Mapping Source Access Configuration Args[] A list of SourceAccessConfiguration.
- starting
Position string The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
- starting
Position numberTimestamp With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
- topics string[]
(Kafka) A list of Kafka topics.
- tumbling
Window numberIn Seconds (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
- function_
name str The name of the Lambda function.
- batch_
size int The maximum number of items to retrieve in a single batch.
- bisect_
batch_ boolon_ function_ error (Streams) If the function returns an error, split the batch in two and retry.
- destination_
config EventSource Mapping Destination Config Args (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- enabled bool
Disables the event source mapping to pause polling and invocation.
- event_
source_ strarn The Amazon Resource Name (ARN) of the event source.
- filter_
criteria EventSource Mapping Filter Criteria Args The filter criteria to control event filtering.
- function_
response_ Eventtypes Source Mapping Function Response Types Item] (Streams) A list of response types supported by the function.
- maximum_
batching_ intwindow_ in_ seconds (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
- maximum_
record_ intage_ in_ seconds (Streams) The maximum age of a record that Lambda sends to a function for processing.
- maximum_
retry_ intattempts (Streams) The maximum number of times to retry when the function returns an error.
- parallelization_
factor int (Streams) The number of batches to process from each shard concurrently.
- queues Sequence[str]
(ActiveMQ) A list of ActiveMQ queues.
- self_
managed_ Eventevent_ source Source Mapping Self Managed Event Source Args Self-managed event source endpoints.
- source_
access_ Eventconfigurations Source Mapping Source Access Configuration Args] A list of SourceAccessConfiguration.
- starting_
position str The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
- starting_
position_ floattimestamp With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
- topics Sequence[str]
(Kafka) A list of Kafka topics.
- tumbling_
window_ intin_ seconds (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
- function
Name String The name of the Lambda function.
- batch
Size Number The maximum number of items to retrieve in a single batch.
- bisect
Batch BooleanOn Function Error (Streams) If the function returns an error, split the batch in two and retry.
- destination
Config Property Map (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
- enabled Boolean
Disables the event source mapping to pause polling and invocation.
- event
Source StringArn The Amazon Resource Name (ARN) of the event source.
- filter
Criteria Property Map The filter criteria to control event filtering.
- function
Response List<"ReportTypes Batch Item Failures"> (Streams) A list of response types supported by the function.
- maximum
Batching NumberWindow In Seconds (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
- maximum
Record NumberAge In Seconds (Streams) The maximum age of a record that Lambda sends to a function for processing.
- maximum
Retry NumberAttempts (Streams) The maximum number of times to retry when the function returns an error.
- parallelization
Factor Number (Streams) The number of batches to process from each shard concurrently.
- queues
List
(ActiveMQ) A list of ActiveMQ queues.
- self
Managed Property MapEvent Source Self-managed event source endpoints.
- source
Access ListConfigurations A list of SourceAccessConfiguration.
- starting
Position String The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
- starting
Position NumberTimestamp With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
- topics
List
(Kafka) A list of Kafka topics.
- tumbling
Window NumberIn Seconds (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
Outputs
All input properties are implicitly available as output properties. Additionally, the EventSourceMapping resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Supporting Types
EventSourceMappingDestinationConfig
- On
Failure Pulumi.Aws Native. Lambda. Inputs. Event Source Mapping On Failure The destination configuration for failed invocations.
- On
Failure EventSource Mapping On Failure The destination configuration for failed invocations.
- on
Failure EventSource Mapping On Failure The destination configuration for failed invocations.
- on
Failure EventSource Mapping On Failure The destination configuration for failed invocations.
- on_
failure EventSource Mapping On Failure The destination configuration for failed invocations.
- on
Failure Property Map The destination configuration for failed invocations.
EventSourceMappingEndpoints
- Kafka
Bootstrap List<string>Servers A list of Kafka server endpoints.
- Kafka
Bootstrap []stringServers A list of Kafka server endpoints.
- kafka
Bootstrap ListServers A list of Kafka server endpoints.
- kafka
Bootstrap string[]Servers A list of Kafka server endpoints.
- kafka_
bootstrap_ Sequence[str]servers A list of Kafka server endpoints.
- kafka
Bootstrap ListServers A list of Kafka server endpoints.
EventSourceMappingFilter
- Pattern string
The filter pattern that defines which events should be passed for invocations.
- Pattern string
The filter pattern that defines which events should be passed for invocations.
- pattern String
The filter pattern that defines which events should be passed for invocations.
- pattern string
The filter pattern that defines which events should be passed for invocations.
- pattern str
The filter pattern that defines which events should be passed for invocations.
- pattern String
The filter pattern that defines which events should be passed for invocations.
EventSourceMappingFilterCriteria
- Filters
List<Pulumi.
Aws Native. Lambda. Inputs. Event Source Mapping Filter> List of filters of this FilterCriteria
- Filters
[]Event
Source Mapping Filter List of filters of this FilterCriteria
- filters
List
Source Mapping Filter> List of filters of this FilterCriteria
- filters
Event
Source Mapping Filter[] List of filters of this FilterCriteria
- filters
Event
Source Mapping Filter] List of filters of this FilterCriteria
EventSourceMappingFunctionResponseTypesItem
- Report
Batch Item Failures - ReportBatchItemFailures
- Event
Source Mapping Function Response Types Item Report Batch Item Failures - ReportBatchItemFailures
- Report
Batch Item Failures - ReportBatchItemFailures
- Report
Batch Item Failures - ReportBatchItemFailures
- REPORT_BATCH_ITEM_FAILURES
- ReportBatchItemFailures
- "Report
Batch Item Failures" - ReportBatchItemFailures
EventSourceMappingOnFailure
- Destination string
The Amazon Resource Name (ARN) of the destination resource.
- Destination string
The Amazon Resource Name (ARN) of the destination resource.
- destination String
The Amazon Resource Name (ARN) of the destination resource.
- destination string
The Amazon Resource Name (ARN) of the destination resource.
- destination str
The Amazon Resource Name (ARN) of the destination resource.
- destination String
The Amazon Resource Name (ARN) of the destination resource.
EventSourceMappingSelfManagedEventSource
- Endpoints
Pulumi.
Aws Native. Lambda. Inputs. Event Source Mapping Endpoints The endpoints for a self-managed event source.
- Endpoints
Event
Source Mapping Endpoints The endpoints for a self-managed event source.
- endpoints
Event
Source Mapping Endpoints The endpoints for a self-managed event source.
- endpoints
Event
Source Mapping Endpoints The endpoints for a self-managed event source.
- endpoints
Event
Source Mapping Endpoints The endpoints for a self-managed event source.
- endpoints Property Map
The endpoints for a self-managed event source.
EventSourceMappingSourceAccessConfiguration
- Type
Pulumi.
Aws Native. Lambda. Event Source Mapping Source Access Configuration Type The type of source access configuration.
- URI string
The URI for the source access configuration resource.
- Type
Event
Source Mapping Source Access Configuration Type The type of source access configuration.
- URI string
The URI for the source access configuration resource.
- type
Event
Source Mapping Source Access Configuration Type The type of source access configuration.
- u
RI String The URI for the source access configuration resource.
- type
Event
Source Mapping Source Access Configuration Type The type of source access configuration.
- u
RI string The URI for the source access configuration resource.
- type
Event
Source Mapping Source Access Configuration Type The type of source access configuration.
- u_
ri str The URI for the source access configuration resource.
- type "BASIC_AUTH" | "VPC_SUBNET" | "VPC_SECURITY_GROUP" | "SASL_SCRAM_512_AUTH" | "SASL_SCRAM_256_AUTH" | "VIRTUAL_HOST" | "CLIENT_CERTIFICATE_TLS_AUTH" | "SERVER_ROOT_CA_CERTIFICATE"
The type of source access configuration.
- u
RI String The URI for the source access configuration resource.
EventSourceMappingSourceAccessConfigurationType
- Basic
Auth - BASIC_AUTH
- Vpc
Subnet - VPC_SUBNET
- Vpc
Security Group - VPC_SECURITY_GROUP
- Sasl
Scram512Auth - SASL_SCRAM_512_AUTH
- Sasl
Scram256Auth - SASL_SCRAM_256_AUTH
- Virtual
Host - VIRTUAL_HOST
- Client
Certificate Tls Auth - CLIENT_CERTIFICATE_TLS_AUTH
- Server
Root Ca Certificate - SERVER_ROOT_CA_CERTIFICATE
- Event
Source Mapping Source Access Configuration Type Basic Auth - BASIC_AUTH
- Event
Source Mapping Source Access Configuration Type Vpc Subnet - VPC_SUBNET
- Event
Source Mapping Source Access Configuration Type Vpc Security Group - VPC_SECURITY_GROUP
- Event
Source Mapping Source Access Configuration Type Sasl Scram512Auth - SASL_SCRAM_512_AUTH
- Event
Source Mapping Source Access Configuration Type Sasl Scram256Auth - SASL_SCRAM_256_AUTH
- Event
Source Mapping Source Access Configuration Type Virtual Host - VIRTUAL_HOST
- Event
Source Mapping Source Access Configuration Type Client Certificate Tls Auth - CLIENT_CERTIFICATE_TLS_AUTH
- Event
Source Mapping Source Access Configuration Type Server Root Ca Certificate - SERVER_ROOT_CA_CERTIFICATE
- Basic
Auth - BASIC_AUTH
- Vpc
Subnet - VPC_SUBNET
- Vpc
Security Group - VPC_SECURITY_GROUP
- Sasl
Scram512Auth - SASL_SCRAM_512_AUTH
- Sasl
Scram256Auth - SASL_SCRAM_256_AUTH
- Virtual
Host - VIRTUAL_HOST
- Client
Certificate Tls Auth - CLIENT_CERTIFICATE_TLS_AUTH
- Server
Root Ca Certificate - SERVER_ROOT_CA_CERTIFICATE
- Basic
Auth - BASIC_AUTH
- Vpc
Subnet - VPC_SUBNET
- Vpc
Security Group - VPC_SECURITY_GROUP
- Sasl
Scram512Auth - SASL_SCRAM_512_AUTH
- Sasl
Scram256Auth - SASL_SCRAM_256_AUTH
- Virtual
Host - VIRTUAL_HOST
- Client
Certificate Tls Auth - CLIENT_CERTIFICATE_TLS_AUTH
- Server
Root Ca Certificate - SERVER_ROOT_CA_CERTIFICATE
- BASIC_AUTH
- BASIC_AUTH
- VPC_SUBNET
- VPC_SUBNET
- VPC_SECURITY_GROUP
- VPC_SECURITY_GROUP
- SASL_SCRAM512_AUTH
- SASL_SCRAM_512_AUTH
- SASL_SCRAM256_AUTH
- SASL_SCRAM_256_AUTH
- VIRTUAL_HOST
- VIRTUAL_HOST
- CLIENT_CERTIFICATE_TLS_AUTH
- CLIENT_CERTIFICATE_TLS_AUTH
- SERVER_ROOT_CA_CERTIFICATE
- SERVER_ROOT_CA_CERTIFICATE
- "BASIC_AUTH"
- BASIC_AUTH
- "VPC_SUBNET"
- VPC_SUBNET
- "VPC_SECURITY_GROUP"
- VPC_SECURITY_GROUP
- "SASL_SCRAM_512_AUTH"
- SASL_SCRAM_512_AUTH
- "SASL_SCRAM_256_AUTH"
- SASL_SCRAM_256_AUTH
- "VIRTUAL_HOST"
- VIRTUAL_HOST
- "CLIENT_CERTIFICATE_TLS_AUTH"
- CLIENT_CERTIFICATE_TLS_AUTH
- "SERVER_ROOT_CA_CERTIFICATE"
- SERVER_ROOT_CA_CERTIFICATE
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws-native
- License
- Apache-2.0