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 8.2.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.aws in release 1.0.0.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.26.0

  • botocore >= 1.29.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

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 AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

alias

string

Name of the function alias.

Mutually exclusive with version.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

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.

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

event_source

string

Source of the event that triggers the lambda function.

For DynamoDB and Kinesis events, select stream.

For SQS queues, select sqs.

Choices:

  • "stream" ← (default)

  • "sqs"

lambda_function_arn

aliases: function_name, function_arn

string / required

The name or ARN of the lambda function.

profile

aliases: aws_profile

string

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 AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

source_params

dictionary / required

Sub-parameters required for event source.

batch_size

integer

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.

Amazon Kinesis - Default 100. Max 10000.

Amazon DynamoDB Streams - Default 100. Max 10000.

Amazon Simple Queue Service - Default 10. For standard queues the max is 10000. For FIFO queues the max is 10.

Amazon Managed Streaming for Apache Kafka - Default 100. Max 10000.

Self-managed Apache Kafka - Default 100. Max 10000.

Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10000.

DocumentDB - Default 100. Max 10000.

enabled

boolean

Indicates whether AWS Lambda should begin polling or readin from the event source.

Choices:

  • false

  • true ← (default)

function_response_types

list / elements=string

added in amazon.aws 5.5.0

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

Choices:

  • "ReportBatchItemFailures"

maximum_batching_window_in_seconds

integer

added in amazon.aws 8.0.0

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

You can configure source_params.maximum_batching_window_in_seconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, when source_params.batch_size is set to a value greater than 10, source_params.maximum_batching_window_in_seconds defaults to 1.

source_params.maximum_batching_window_in_seconds is not supported by FIFO queues.

source_arn

string / required

The Amazon Resource Name (ARN) of the SQS queue, Kinesis stream or DynamoDB stream that is the event source.

starting_position

string

The position in the stream where AWS Lambda should start reading.

Required when event_source=stream.

Choices:

  • "TRIM_HORIZON"

  • "LATEST"

state

string

Describes the desired state.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

version

integer

Version of the Lambda function.

Mutually exclusive with alias.

Default: 0

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

events

dictionary

Dictionary returned by the API describing stream event mappings

Returned: success

batch_size

integer

The maximum number of records in each batch that Lambda pulls.

Returned: always

bisect_batch_on_function_error

boolean

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

Returned: for Kinesis and DynamoDB Streams only

Sample: false

destination_config

dictionary

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

on_failure

dictionary

The destination configuration for failed invocations.

Returned: success

destination

string

Destination resource ARN.

Returned: success

on_success

dictionary

The destination configuration for failed invocations.

Returned: success

destination

string

Destination resource ARN.

Returned: success

event_source_arn

string

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

Returned: always

Sample: "arn:aws:dynamodb:us-west-2:123456789012:table/yyyy/stream/2024-06-06T07:03:58.956"

function_arn

string

The ARN of the Lambda function.

Returned: always

Sample: "arn:aws:lambda:us-west-2:123456789012:function:test-lambda-3a0a29d0dbb5:1"

function_response_types

list / elements=string

A list of current response type enums applied to the event source mapping.

Returned: For Kinesis, DynamoDB Streams, and Amazon SQS

Sample: ["ReportBatchItemFailures"]

last_modified

string

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

Returned: always

Sample: "2024-06-06T12:34:21.990000+05:30"

last_processing_result

string

The result of the last Lambda invocation of your function.

Returned: always

Sample: "No records processed"

maximum_batching_window_in_seconds

integer

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

Returned: always

Sample: 1

maximum_record_age_in_seconds

integer

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

Returned: For Kinesis and DynamoDB Streams only

Sample: -1

maximum_retry_attempts

integer

Discard records after the specified number of retries.

Returned: For Kinesis and DynamoDB Streams only

Sample: -1

parallelization_factor

integer

The number of batches to process concurrently from each shard.

Returned: For Kinesis and DynamoDB Streams only

Sample: 1

starting_position

string

The position in a stream from which to start reading.

Returned: For Kinesis and DynamoDB Streams only

Sample: "LATEST"

state

string

The state of the event source mapping.

Returned: always

Sample: "deleting"

state_transition_reason

string

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

Returned: always

Sample: "USER_INITIATED"

tumbling_window_in_seconds

integer

The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

Returned: For Kinesis and DynamoDB Streams only

Sample: 1

uuid

string

The identifier of the event source mapping.

Returned: always

Sample: "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"

Authors

  • Pierre Jodouin (@pjodouin)

  • Ryan Brown (@ryansb)