W3cubDocs

/Ansible

lambda - Manage AWS Lambda functions

New in version 2.2.

Synopsis

Allows for the management of Lambda functions.

Requirements (on host that executes module)

  • boto
  • boto3
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
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
 no
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
description
 no
A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
ec2_url
 no
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.
handler
 no
The function within your code that Lambda calls to begin execution
memory_size
 no 128
The amount of memory, in MB, your Lambda function is given
name
 yes
The name you want to assign to the function you are uploading. Cannot be changed.
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
region
 no
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
role
 no
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. You may use the bare ARN if the role belongs to the same AWS account.
runtime
 yes
The runtime environment for the Lambda function you are uploading. Required when creating a function. Use parameters as described in boto3 docs. Current example runtime environments are nodejs, nodejs4.3, java8 or python2.7
s3_bucket
 no
Amazon S3 bucket name where the .zip file containing your deployment package is stored
s3_key
 no
The Amazon S3 object (the deployment package) key name you want to upload
s3_object_version
 no
The Amazon S3 object (the deployment package) version you want to upload.
security_token
(added in 1.6)
 no
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
state
 no present
  • present
  • absent
Create or delete Lambda function
timeout
 no 3
The function execution time at which Lambda should terminate the function.
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_security_group_ids
 no None
List of VPC security group IDs to associate with the Lambda function. Required when vpc_subnet_ids is used.
vpc_subnet_ids
 no None
List of subnet IDs to run Lambda function in. Use this option if you need to access resources in your VPC. Leave empty if you don't want to run the function in a VPC.
zip_file
 no
A .zip file containing your deployment package
aliases: src

Examples

# Create Lambda functions
tasks:
- name: looped creation
  lambda:
    name: '{{ item.name }}'
    state: present
    zip_file: '{{ item.zip_file }}'
    runtime: 'python2.7'
    role: 'arn:aws:iam::987654321012:role/lambda_basic_execution'
    handler: 'hello_python.my_handler'
    vpc_subnet_ids:
    - subnet-123abcde
    - subnet-edcba321
    vpc_security_group_ids:
    - sg-123abcde
    - sg-edcba321
  with_items:
    - { name: HelloWorld, zip_file: 'hello-code.zip' }
    - { name: ByeBye, zip_file: 'bye-code.zip' }

# Basic Lambda function deletion
tasks:
- name: Delete Lambda functions HelloWorld and ByeBye
  lambda:
    name: '{{ item }}'
    state: absent
  with_items:
    - HelloWorld
    - ByeBye

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

name description returned type sample
output the data returned by create_function in boto3 success dict {'code': {'repository_type': 'S3', 'location': 'an S3 URL'}, 'configuration': {'description': 'string', 'function_arn': 'string', 'handler': 'string', 'timeout': 123, 'last_modified': 'string', 'role': 'string', 'version': 'string', 'code_sha256': 'string', 'memory_size': 123, 'runtime': 'nodejs', 'code_size': 123, 'function_name': 'string'}}

Notes

Note

Currently this module only supports uploaded code via S3

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence 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

Note

Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

Note

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

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/lambda_module.html