AWS Native

Pulumi Official
Package maintained by Pulumi
v0.16.1 published on Saturday, Apr 30, 2022 by Pulumi

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:

FunctionName string

The name of the Lambda function.

BatchSize int

The maximum number of items to retrieve in a single batch.

BisectBatchOnFunctionError bool

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

DestinationConfig Pulumi.AwsNative.Lambda.Inputs.EventSourceMappingDestinationConfigArgs

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

EventSourceArn string

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

FilterCriteria Pulumi.AwsNative.Lambda.Inputs.EventSourceMappingFilterCriteriaArgs

The filter criteria to control event filtering.

FunctionResponseTypes List<Pulumi.AwsNative.Lambda.EventSourceMappingFunctionResponseTypesItem>

(Streams) A list of response types supported by the function.

MaximumBatchingWindowInSeconds int

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

MaximumRecordAgeInSeconds int

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

MaximumRetryAttempts int

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

ParallelizationFactor int

(Streams) The number of batches to process from each shard concurrently.

Queues List<string>

(ActiveMQ) A list of ActiveMQ queues.

SelfManagedEventSource Pulumi.AwsNative.Lambda.Inputs.EventSourceMappingSelfManagedEventSourceArgs

Self-managed event source endpoints.

SourceAccessConfigurations List<Pulumi.AwsNative.Lambda.Inputs.EventSourceMappingSourceAccessConfigurationArgs>

A list of SourceAccessConfiguration.

StartingPosition string

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

StartingPositionTimestamp double

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.

TumblingWindowInSeconds int

(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.

FunctionName string

The name of the Lambda function.

BatchSize int

The maximum number of items to retrieve in a single batch.

BisectBatchOnFunctionError bool

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

DestinationConfig EventSourceMappingDestinationConfigArgs

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

EventSourceArn string

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

FilterCriteria EventSourceMappingFilterCriteriaArgs

The filter criteria to control event filtering.

FunctionResponseTypes []EventSourceMappingFunctionResponseTypesItem

(Streams) A list of response types supported by the function.

MaximumBatchingWindowInSeconds int

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

MaximumRecordAgeInSeconds int

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

MaximumRetryAttempts int

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

ParallelizationFactor int

(Streams) The number of batches to process from each shard concurrently.

Queues []string

(ActiveMQ) A list of ActiveMQ queues.

SelfManagedEventSource EventSourceMappingSelfManagedEventSourceArgs

Self-managed event source endpoints.

SourceAccessConfigurations []EventSourceMappingSourceAccessConfigurationArgs

A list of SourceAccessConfiguration.

StartingPosition string

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

StartingPositionTimestamp float64

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.

TumblingWindowInSeconds int

(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.

functionName String

The name of the Lambda function.

batchSize Integer

The maximum number of items to retrieve in a single batch.

bisectBatchOnFunctionError Boolean

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

destinationConfig EventSourceMappingDestinationConfigArgs

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

eventSourceArn String

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

filterCriteria EventSourceMappingFilterCriteriaArgs

The filter criteria to control event filtering.

functionResponseTypes ListSourceMappingFunctionResponseTypesItem>

(Streams) A list of response types supported by the function.

maximumBatchingWindowInSeconds Integer

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

maximumRecordAgeInSeconds Integer

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

maximumRetryAttempts Integer

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

parallelizationFactor Integer

(Streams) The number of batches to process from each shard concurrently.

queues List

(ActiveMQ) A list of ActiveMQ queues.

selfManagedEventSource EventSourceMappingSelfManagedEventSourceArgs

Self-managed event source endpoints.

sourceAccessConfigurations ListSourceMappingSourceAccessConfigurationArgs>

A list of SourceAccessConfiguration.

startingPosition String

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

startingPositionTimestamp Double

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.

tumblingWindowInSeconds Integer

(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.

functionName string

The name of the Lambda function.

batchSize number

The maximum number of items to retrieve in a single batch.

bisectBatchOnFunctionError boolean

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

destinationConfig EventSourceMappingDestinationConfigArgs

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

eventSourceArn string

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

filterCriteria EventSourceMappingFilterCriteriaArgs

The filter criteria to control event filtering.

functionResponseTypes EventSourceMappingFunctionResponseTypesItem[]

(Streams) A list of response types supported by the function.

maximumBatchingWindowInSeconds number

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

maximumRecordAgeInSeconds number

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

maximumRetryAttempts number

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

parallelizationFactor number

(Streams) The number of batches to process from each shard concurrently.

queues string[]

(ActiveMQ) A list of ActiveMQ queues.

selfManagedEventSource EventSourceMappingSelfManagedEventSourceArgs

Self-managed event source endpoints.

sourceAccessConfigurations EventSourceMappingSourceAccessConfigurationArgs[]

A list of SourceAccessConfiguration.

startingPosition string

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

startingPositionTimestamp number

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.

tumblingWindowInSeconds number

(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_on_function_error bool

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

destination_config EventSourceMappingDestinationConfigArgs

(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_arn str

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

filter_criteria EventSourceMappingFilterCriteriaArgs

The filter criteria to control event filtering.

function_response_types EventSourceMappingFunctionResponseTypesItem]

(Streams) A list of response types supported by the function.

maximum_batching_window_in_seconds int

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

maximum_record_age_in_seconds int

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

maximum_retry_attempts int

(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_event_source EventSourceMappingSelfManagedEventSourceArgs

Self-managed event source endpoints.

source_access_configurations EventSourceMappingSourceAccessConfigurationArgs]

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_timestamp float

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_in_seconds int

(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.

functionName String

The name of the Lambda function.

batchSize Number

The maximum number of items to retrieve in a single batch.

bisectBatchOnFunctionError Boolean

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

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

eventSourceArn String

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

filterCriteria Property Map

The filter criteria to control event filtering.

functionResponseTypes List<"ReportBatchItemFailures">

(Streams) A list of response types supported by the function.

maximumBatchingWindowInSeconds Number

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

maximumRecordAgeInSeconds Number

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

maximumRetryAttempts Number

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

parallelizationFactor Number

(Streams) The number of batches to process from each shard concurrently.

queues List

(ActiveMQ) A list of ActiveMQ queues.

selfManagedEventSource Property Map

Self-managed event source endpoints.

sourceAccessConfigurations List

A list of SourceAccessConfiguration.

startingPosition String

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

startingPositionTimestamp Number

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.

tumblingWindowInSeconds Number

(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

OnFailure Pulumi.AwsNative.Lambda.Inputs.EventSourceMappingOnFailure

The destination configuration for failed invocations.

OnFailure EventSourceMappingOnFailure

The destination configuration for failed invocations.

onFailure EventSourceMappingOnFailure

The destination configuration for failed invocations.

onFailure EventSourceMappingOnFailure

The destination configuration for failed invocations.

on_failure EventSourceMappingOnFailure

The destination configuration for failed invocations.

onFailure Property Map

The destination configuration for failed invocations.

EventSourceMappingEndpoints

KafkaBootstrapServers List<string>

A list of Kafka server endpoints.

KafkaBootstrapServers []string

A list of Kafka server endpoints.

kafkaBootstrapServers List

A list of Kafka server endpoints.

kafkaBootstrapServers string[]

A list of Kafka server endpoints.

kafka_bootstrap_servers Sequence[str]

A list of Kafka server endpoints.

kafkaBootstrapServers List

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 []EventSourceMappingFilter

List of filters of this FilterCriteria

filters ListSourceMappingFilter>

List of filters of this FilterCriteria

filters EventSourceMappingFilter[]

List of filters of this FilterCriteria

filters EventSourceMappingFilter]

List of filters of this FilterCriteria

filters List

List of filters of this FilterCriteria

EventSourceMappingFunctionResponseTypesItem

ReportBatchItemFailures
ReportBatchItemFailures
EventSourceMappingFunctionResponseTypesItemReportBatchItemFailures
ReportBatchItemFailures
ReportBatchItemFailures
ReportBatchItemFailures
ReportBatchItemFailures
ReportBatchItemFailures
REPORT_BATCH_ITEM_FAILURES
ReportBatchItemFailures
"ReportBatchItemFailures"
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.AwsNative.Lambda.Inputs.EventSourceMappingEndpoints

The endpoints for a self-managed event source.

Endpoints EventSourceMappingEndpoints

The endpoints for a self-managed event source.

endpoints EventSourceMappingEndpoints

The endpoints for a self-managed event source.

endpoints EventSourceMappingEndpoints

The endpoints for a self-managed event source.

endpoints EventSourceMappingEndpoints

The endpoints for a self-managed event source.

endpoints Property Map

The endpoints for a self-managed event source.

EventSourceMappingSourceAccessConfiguration

Type Pulumi.AwsNative.Lambda.EventSourceMappingSourceAccessConfigurationType

The type of source access configuration.

URI string

The URI for the source access configuration resource.

Type EventSourceMappingSourceAccessConfigurationType

The type of source access configuration.

URI string

The URI for the source access configuration resource.

type EventSourceMappingSourceAccessConfigurationType

The type of source access configuration.

uRI String

The URI for the source access configuration resource.

type EventSourceMappingSourceAccessConfigurationType

The type of source access configuration.

uRI string

The URI for the source access configuration resource.

type EventSourceMappingSourceAccessConfigurationType

The type of source access configuration.

u_ri str

The URI for the source access configuration resource.

EventSourceMappingSourceAccessConfigurationType

BasicAuth
BASIC_AUTH
VpcSubnet
VPC_SUBNET
VpcSecurityGroup
VPC_SECURITY_GROUP
SaslScram512Auth
SASL_SCRAM_512_AUTH
SaslScram256Auth
SASL_SCRAM_256_AUTH
VirtualHost
VIRTUAL_HOST
ClientCertificateTlsAuth
CLIENT_CERTIFICATE_TLS_AUTH
ServerRootCaCertificate
SERVER_ROOT_CA_CERTIFICATE
EventSourceMappingSourceAccessConfigurationTypeBasicAuth
BASIC_AUTH
EventSourceMappingSourceAccessConfigurationTypeVpcSubnet
VPC_SUBNET
EventSourceMappingSourceAccessConfigurationTypeVpcSecurityGroup
VPC_SECURITY_GROUP
EventSourceMappingSourceAccessConfigurationTypeSaslScram512Auth
SASL_SCRAM_512_AUTH
EventSourceMappingSourceAccessConfigurationTypeSaslScram256Auth
SASL_SCRAM_256_AUTH
EventSourceMappingSourceAccessConfigurationTypeVirtualHost
VIRTUAL_HOST
EventSourceMappingSourceAccessConfigurationTypeClientCertificateTlsAuth
CLIENT_CERTIFICATE_TLS_AUTH
EventSourceMappingSourceAccessConfigurationTypeServerRootCaCertificate
SERVER_ROOT_CA_CERTIFICATE
BasicAuth
BASIC_AUTH
VpcSubnet
VPC_SUBNET
VpcSecurityGroup
VPC_SECURITY_GROUP
SaslScram512Auth
SASL_SCRAM_512_AUTH
SaslScram256Auth
SASL_SCRAM_256_AUTH
VirtualHost
VIRTUAL_HOST
ClientCertificateTlsAuth
CLIENT_CERTIFICATE_TLS_AUTH
ServerRootCaCertificate
SERVER_ROOT_CA_CERTIFICATE
BasicAuth
BASIC_AUTH
VpcSubnet
VPC_SUBNET
VpcSecurityGroup
VPC_SECURITY_GROUP
SaslScram512Auth
SASL_SCRAM_512_AUTH
SaslScram256Auth
SASL_SCRAM_256_AUTH
VirtualHost
VIRTUAL_HOST
ClientCertificateTlsAuth
CLIENT_CERTIFICATE_TLS_AUTH
ServerRootCaCertificate
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