amazon.aws.lambda_event module – Creates, updates or deletes AWS Lambda function event mappings
Note
This module is part of the amazon.aws collection (version 9.5.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install amazon.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.lambda_event.
New in amazon.aws 5.0.0
Synopsis
This module allows the management of AWS Lambda function event source mappings such as DynamoDB and Kinesis stream events via the Ansible framework. These event source mappings are relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. It is idempotent and supports “Check” mode. Use module amazon.aws.lambda to manage the lambda function itself and amazon.aws.lambda_alias to manage function aliases.
This module was originally added to
community.awsin release 1.0.0.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Name of the function alias. Mutually exclusive with |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Source of the event that triggers the lambda function. For DynamoDB and Kinesis events, select For SQS queues, select Choices:
|
|
The name or ARN of the lambda function. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Sub-parameters required for event source. |
|
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Amazon Kinesis - Default Amazon DynamoDB Streams - Default Amazon Simple Queue Service - Default Amazon Managed Streaming for Apache Kafka - Default Self-managed Apache Kafka - Default Amazon MQ (ActiveMQ and RabbitMQ) - Default DocumentDB - Default |
|
Indicates whether AWS Lambda should begin polling or readin from the event source. Choices:
|
|
(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping. Choices:
|
|
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure For streams and Amazon SQS event sources, when
|
|
The Amazon Resource Name (ARN) of the SQS queue, Kinesis stream or DynamoDB stream that is the event source. |
|
The position in the stream where AWS Lambda should start reading. Required when Choices:
|
|
Describes the desired state. Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Example that creates a lambda event notification for a DynamoDB stream
- name: DynamoDB stream event mapping
amazon.aws.lambda_event:
state: present
event_source: stream
function_name: "{{ function_name }}"
alias: Dev
source_params:
source_arn: arn:aws:dynamodb:us-east-1:123456789012:table/tableName/stream/2016-03-19T19:51:37.457
enabled: true
batch_size: 100
starting_position: TRIM_HORIZON
register: event
# Example that creates a lambda event notification for a DynamoDB stream
- name: DynamoDB stream event mapping
amazon.aws.lambda_event:
state: present
event_source: stream
function_name: "{{ function_name }}"
source_params:
source_arn: arn:aws:dynamodb:us-east-1:123456789012:table/tableName/stream/2016-03-19T19:51:37.457
enabled: true
batch_size: 100
starting_position: LATEST
function_response_types:
- ReportBatchItemFailures
register: event
- name: Show source event
ansible.builtin.debug:
var: event.lambda_stream_events
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Dictionary returned by the API describing stream event mappings Returned: success |
|
The maximum number of records in each batch that Lambda pulls. Returned: always |
|
If the function returns an error, split the batch in two and retry. Returned: for Kinesis and DynamoDB Streams only Sample: |
|
Configuration object that specifies the destination of an event after Lambda processes it. Returned: For Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only |
|
The destination configuration for failed invocations. Returned: success |
|
Destination resource ARN. Returned: success |
|
The destination configuration for failed invocations. Returned: success |
|
Destination resource ARN. Returned: success |
|
The Amazon Resource Name (ARN) of the event source. Returned: always Sample: |
|
The ARN of the Lambda function. Returned: always Sample: |
|
A list of current response type enums applied to the event source mapping. Returned: For Kinesis, DynamoDB Streams, and Amazon SQS Sample: |
|
The date that the event source mapping was last updated or that its state changed. Returned: always Sample: |
|
The result of the last Lambda invocation of your function. Returned: always Sample: |
|
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. Returned: always Sample: |
|
Discard records older than the specified age. The default value is infinite (-1). Returned: For Kinesis and DynamoDB Streams only Sample: |
|
Discard records after the specified number of retries. Returned: For Kinesis and DynamoDB Streams only Sample: |
|
The number of batches to process concurrently from each shard. Returned: For Kinesis and DynamoDB Streams only Sample: |
|
The position in a stream from which to start reading. Returned: For Kinesis and DynamoDB Streams only Sample: |
|
The state of the event source mapping. Returned: always Sample: |
|
Indicates whether a user or Lambda made the last change to the event source mapping. Returned: always Sample: |
|
The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. Returned: For Kinesis and DynamoDB Streams only Sample: |
|
The identifier of the event source mapping. Returned: always Sample: |