New in version 2.2.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
alias required | Name of the function alias. Mutually exclusive with version . | |
aws_access_key | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key | |
aws_secret_key | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key | |
ec2_url | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
event_source |
| Source of the event that triggers the lambda function. For DynamoDB and Kinesis events, select 'stream' For SQS queues, select 'sqs' |
lambda_function_arn required | The name or ARN of the lambda function. aliases: function_name, function_arn | |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
region | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region | |
security_token (added in 1.6) | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token | |
source_params required | Sub-parameters required for event source. == stream event source == source_arn The Amazon Resource Name (ARN) of the Kinesis or DynamoDB stream that is the event source.enabled Indicates whether AWS Lambda should begin polling the event source. Default is True.batch_size The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Default is 100.starting_position The position in the stream where AWS Lambda should start reading. Choices are TRIM_HORIZON or LATEST.== sqs event source == source_arn The Amazon Resource Name (ARN) of the SQS queue to read events from.enabled Indicates whether AWS Lambda should begin reading from the event source. Default is True.batch_size The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Default is 100. | |
state required |
| Describes the desired state. |
validate_certs bool (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
version | Version of the Lambda function. Mutually exclusive with alias . |
Note
AWS_URL
or EC2_URL
, AWS_ACCESS_KEY_ID
or AWS_ACCESS_KEY
or EC2_ACCESS_KEY
, AWS_SECRET_ACCESS_KEY
or AWS_SECRET_KEY
or EC2_SECRET_KEY
, AWS_SECURITY_TOKEN
or EC2_SECURITY_TOKEN
, AWS_REGION
or EC2_REGION
AWS_REGION
or EC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file--- # Example that creates a lambda event notification for a DynamoDB stream - hosts: localhost gather_facts: no vars: state: present tasks: - name: DynamoDB stream event mapping lambda_event: state: "{{ state | default('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 - name: Show source event debug: var: lambda_stream_events
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
lambda_stream_events list | success | list of dictionaries returned by the API describing stream event mappings |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/lambda_event_module.html