Try SpotterManage AWS Lambda functions
| "added in version" 2.2 of ansible.builtin"
Authors: Steyn Huizinga (@steynovich)
preview | supported by community
pipInstall with pip install ansible==2.5.12
Allows for the management of Lambda functions.
# Create Lambda functions
- 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
environment_variables: '{{ item.env_vars }}'
tags:
key1: 'value1'
with_items:
- name: HelloWorld
zip_file: hello-code.zip
env_vars:
key1: "first"
key2: "second"
- name: ByeBye
zip_file: bye-code.zip
env_vars:
key1: "1"
key2: "2"
# To remove previously added tags pass a empty dict
- name: remove tags
lambda:
name: 'Lambda function'
state: present
zip_file: 'code.zip'
runtime: 'python2.7'
role: 'arn:aws:iam::987654321012:role/lambda_basic_execution'
handler: 'hello_python.my_handler'
tags: {}
# Basic Lambda function deletion
- name: Delete Lambda functions HelloWorld and ByeBye
lambda:
name: '{{ item }}'
state: absent
with_items:
- HelloWorld
- ByeBye
name:
description:
- The name you want to assign to the function you are uploading. Cannot be changed.
required: true
role:
description:
- 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.
- Required when C(state=present)
tags:
default: None
description:
- tag dict to apply to the function (requires botocore 1.5.40 or above)
required: false
version_added: '2.5'
version_added_collection: ansible.builtin
state:
choices:
- present
- absent
default: present
description:
- Create or delete Lambda function
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
s3_key:
default: null
description:
- The Amazon S3 object (the deployment package) key name you want to upload
- s3_bucket and s3_key are required together
required: false
handler:
default: null
description:
- The function within your code that Lambda calls to begin execution
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
runtime:
description:
- 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
- Required when C(state=present)
timeout:
default: 3
description:
- The function execution time at which Lambda should terminate the function.
required: false
zip_file:
aliases:
- src
default: null
description:
- A .zip file containing your deployment package
- If C(state=present) then either zip_file or s3_bucket must be present.
required: false
s3_bucket:
default: null
description:
- Amazon S3 bucket name where the .zip file containing your deployment package is
stored
- If C(state=present) then either zip_file or s3_bucket must be present.
- s3_bucket and s3_key are required together
required: false
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
description:
default: null
description:
- A short, user-defined function description. Lambda does not use this value. Assign
a meaningful description as you see fit.
required: false
memory_size:
default: 128
description:
- The amount of memory, in MB, your Lambda function is given
required: false
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
vpc_subnet_ids:
default: None
description:
- 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.
required: false
dead_letter_arn:
default: None
description:
- The parent object that contains the target Amazon Resource Name (ARN) of an Amazon
SQS queue or Amazon SNS topic.
required: false
version_added: '2.3'
version_added_collection: ansible.builtin
s3_object_version:
default: null
description:
- The Amazon S3 object (the deployment package) version you want to upload.
required: false
environment_variables:
aliases:
- environment
default: None
description:
- A dictionary of environment variables the Lambda function is given.
required: false
version_added: '2.3'
version_added_collection: ansible.builtin
vpc_security_group_ids:
default: None
description:
- List of VPC security group IDs to associate with the Lambda function. Required when
vpc_subnet_ids is used.
required: false
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
code:
description: the lambda function location returned by get_function in boto3
returned: success
sample:
location: a presigned S3 URL
repository_type: S3
type: dict
configuration:
description: the lambda function metadata returned by get_function in boto3
returned: success
sample:
code_sha256: SHA256 hash
code_size: 123
description: My function
environment:
variables:
key: value
function_arn: arn:aws:lambda:us-east-1:123456789012:function:myFunction:1
function_name: myFunction
handler: index.handler
last_modified: 2017-08-01T00:00:00.000+0000
memory_size: 128
role: arn:aws:iam::123456789012:role/lambda_basic_execution
runtime: nodejs6.10
timeout: 3
version: '1'
vpc_config:
security_group_ids: []
subnet_ids: []
type: dict