create-event-source-mapping¶

Description¶

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics.

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

BisectBatchOnFunctionError - If the function returns an error, split the batch in two and retry.
DestinationConfig - Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds - Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts - Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
ParallelizationFactor - Process multiple batches from each shard concurrently.

Synopsis¶

  create-event-source-mapping
[--event-source-arn <value>]
--function-name <value>
[--enabled | --no-enabled]
[--batch-size <value>]
[--maximum-batching-window-in-seconds <value>]
[--parallelization-factor <value>]
[--starting-position <value>]
[--starting-position-timestamp <value>]
[--destination-config <value>]
[--maximum-record-age-in-seconds <value>]
[--bisect-batch-on-function-error | --no-bisect-batch-on-function-error]
[--maximum-retry-attempts <value>]
[--tumbling-window-in-seconds <value>]
[--topics <value>]
[--queues <value>]
[--source-access-configurations <value>]
[--self-managed-event-source <value>]
[--function-response-types <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--event-source-arn (string)

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.

--function-name (string)

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.

--enabled | --no-enabled (boolean)

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

Default: True

--batch-size (integer)

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 1,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.

--maximum-batching-window-in-seconds (integer)

(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

Default: 0

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

--parallelization-factor (integer)

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

--starting-position (string)

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

Possible values:

TRIM_HORIZON

LATEST

AT_TIMESTAMP

--starting-position-timestamp (timestamp)

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

--destination-config (structure)

(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

OnSuccess -> (structure)

The destination configuration for successful invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

OnFailure -> (structure)

The destination configuration for failed invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

Shorthand Syntax:

OnSuccess={Destination=string},OnFailure={Destination=string}

JSON Syntax:

{
  "OnSuccess": {
    "Destination": "string"
  },
  "OnFailure": {
    "Destination": "string"
  }
}

--maximum-record-age-in-seconds (integer)

(Streams only) Discard records older than the specified age. The default value is infinite (-1).

--bisect-batch-on-function-error | --no-bisect-batch-on-function-error (boolean)

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

--maximum-retry-attempts (integer)

(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.

--tumbling-window-in-seconds (integer)

(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

--topics (list)

The name of the Kafka topic.

(string)

Syntax:

"string" "string" ...

--queues (list)

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

(string)

Syntax:

"string" "string" ...

--source-access-configurations (list)

An array of authentication protocols or VPC components required to secure your event source.

(structure)

To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.

Type -> (string)

The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH" .

BASIC_AUTH - (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

BASIC_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

VPC_SECURITY_GROUP - The VPC security group used to manage access to your self-managed Apache Kafka brokers.

SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

VIRTUAL_HOST - (Amazon MQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source.

URI -> (string)

The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .

Shorthand Syntax:

Type=string,URI=string ...

JSON Syntax:

[
  {
    "Type": "BASIC_AUTH"|"VPC_SUBNET"|"VPC_SECURITY_GROUP"|"SASL_SCRAM_512_AUTH"|"SASL_SCRAM_256_AUTH"|"VIRTUAL_HOST",
    "URI": "string"
  }
  ...
]

--self-managed-event-source (structure)

The Self-Managed Apache Kafka cluster to send records.

Endpoints -> (map)

The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .

key -> (string)

value -> (list)

(string)

Shorthand Syntax:

Endpoints={KeyName1=string,string,KeyName2=string,string}

JSON Syntax:

{
  "Endpoints": {"KAFKA_BOOTSTRAP_SERVERS": ["string", ...]
    ...}
}

--function-response-types (list)

(Streams only) A list of current response type enums applied to the event source mapping.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  ReportBatchItemFailures

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create a mapping between an event source and an AWS Lambda function

The following create-event-source-mapping example creates a mapping between an SQS queue and the my-function Lambda function.

aws lambda create-event-source-mapping \
    --function-name my-function \
    --batch-size 5 \
    --event-source-arn arn:aws:sqs:us-west-2:123456789012:mySQSqueue

Output:

{
    "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "StateTransitionReason": "USER_INITIATED",
    "LastModified": 1569284520.333,
    "BatchSize": 5,
    "State": "Creating",
    "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
    "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue"
}

For more information, see AWS Lambda Event Source Mapping in the AWS Lambda Developer Guide.

Output¶

UUID -> (string)

The identifier of the event source mapping.

StartingPosition -> (string)

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.

StartingPositionTimestamp -> (timestamp)

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

BatchSize -> (integer)

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

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

MaximumBatchingWindowInSeconds -> (integer)

(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

Default: 0

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

ParallelizationFactor -> (integer)

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

EventSourceArn -> (string)

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

FunctionArn -> (string)

The ARN of the Lambda function.

LastModified -> (timestamp)

The date that the event source mapping was last updated or that its state changed.

LastProcessingResult -> (string)

The result of the last Lambda invocation of your function.

State -> (string)

The state of the event source mapping. It can be one of the following: Creating , Enabling , Enabled , Disabling , Disabled , Updating , or Deleting .

StateTransitionReason -> (string)

Indicates whether a user or Lambda made the last change to the event source mapping.

DestinationConfig -> (structure)

(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

OnSuccess -> (structure)

The destination configuration for successful invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

OnFailure -> (structure)

The destination configuration for failed invocations.

Destination -> (string)

The Amazon Resource Name (ARN) of the destination resource.

Topics -> (list)

The name of the Kafka topic.

(string)

Queues -> (list)

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

(string)

SourceAccessConfigurations -> (list)

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

(structure)

To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.

Type -> (string)

The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH" .

BASIC_AUTH - (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

BASIC_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

VPC_SECURITY_GROUP - The VPC security group used to manage access to your self-managed Apache Kafka brokers.

SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

VIRTUAL_HOST - (Amazon MQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source.

URI -> (string)

The value for your chosen configuration in Type . For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .

SelfManagedEventSource -> (structure)

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

Endpoints -> (map)

The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .

key -> (string)

value -> (list)

(string)

MaximumRecordAgeInSeconds -> (integer)

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

BisectBatchOnFunctionError -> (boolean)

(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

MaximumRetryAttempts -> (integer)

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

TumblingWindowInSeconds -> (integer)

(Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.

FunctionResponseTypes -> (list)

(Streams only) A list of current response type enums applied to the event source mapping.

(string)

Table of Contents

Feedback

User Guide

create-event-source-mapping¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶