amazon.cloud.lambda_function module – Create and manage Lambda functions

Note

This module is part of the amazon.cloud collection (version 0.4.0).

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.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.cloud.lambda_function.

New in amazon.cloud 0.1.0

Synopsis

  • Creates and manage Lambda functions.

Requirements

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

  • python >= 3.9

  • boto3 >= 1.25.0

  • botocore >= 1.28.0

  • jsonpatch

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.

architectures

list / elements=string

Not Provived.

Choices:

  • "arm64"

  • "x86_64"

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.

code

dictionary

The code for the function.

image_uri

string

image_uri.

s3_bucket

string

An Amazon S3 bucket in the same AWS Region as your function.

The bucket can be in a different AWS account.

s3_key

string

The Amazon S3 key of the deployment package.

s3_object_version

string

For versioned objects, the version of the deployment package object to use.

zip_file

string

The source code of your Lambda function.

If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index and zips it to create a deployment package..

code_signing_config_arn

string

A unique Arn for CodeSigningConfig resource.

dead_letter_config

dictionary

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.The dead-letter queue for failed asynchronous invocations.

target_arn

string

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

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

description

string

A description of the function.

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.

environment

dictionary

Environment variables that are accessible from function code during execution.A functions environment variable settings.

variables

dictionary

Environment variable key-value pairs.

ephemeral_storage

dictionary

A functions ephemeral storage settings.A functions ephemeral storage settings.

size

integer

The amount of ephemeral storage that your function has access to.

file_system_configs

list / elements=dictionary

Connection settings for an Amazon EFS file system.

To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to.

If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.

local_mount_path

string

The path where the function can access the file system, starting with /mnt/.

force

boolean

Cancel IN_PROGRESS and PENDING resource requestes.

Because you can only perform a single operation on a given resource at a time, there might be cases where you need to cancel the current resource operation to make the resource available so that another operation may be performed on it.

Choices:

  • false ← (default)

  • true

function_name

string

The name of the Lambda function, up to 64 characters in length.

If you dont specify a name, AWS CloudFormation generates one.

handler

string

The name of the method within your code that Lambda calls to execute your function.

The format includes the file name.

It can also include namespaces and other qualifiers, depending on the runtime.

image_config

dictionary

image_config.

command

list / elements=string

Command.

entry_point

list / elements=string

entry_point.

working_directory

string

working_directory.

kms_key_arn

string

The ARN of the AWS Key Management Service (AWS KMS) key thats used to encrypt your functions environment variables.

If its not provided, AWS Lambda uses a default service key.

layers

list / elements=string

A list of function layers to add to the functions execution environment.

Specify each layer by its ARN, including the version.

memory_size

integer

The amount of memory that your function has access to.

Increasing the functions memory also increases its CPU allocation.

The default value is 128 MB. The value must be a multiple of 64 MB.

package_type

string

PackageType.

Choices:

  • "Image"

  • "Zip"

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.

purge_tags

boolean

Remove tags not listed in tags.

Choices:

  • false

  • true ← (default)

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.

reserved_concurrent_executions

integer

The number of simultaneous executions to reserve for the function.

role

string

The Amazon Resource Name (ARN) of the functions execution role.

runtime

string

The identifier of the functions runtime.

runtime_management_config

dictionary

runtime_management_config.

runtime_version_arn

string

Unique identifier for a runtime version arn.

update_runtime_on

string

Trigger for runtime update.

Choices:

  • "Auto"

  • "FunctionUpdate"

  • "Manual"

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.

snap_start

dictionary

The snap_start setting of your functionThe functions snap_start setting.

When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

state

string

Goal state for resource.

state=present creates the resource if it doesn’t exist, or updates to the provided state if the resource already exists.

state=absent ensures an existing instance is deleted.

state=list get all the existing resources.

state=describe or state=get retrieves information on an existing resource.

Choices:

  • "present" ← (default)

  • "absent"

  • "list"

  • "describe"

  • "get"

tags

aliases: resource_tags

dictionary

A dict of tags to apply to the resource.

To remove all tags set tags={} and purge_tags=true.

timeout

integer

The amount of time that Lambda allows a function to run before stopping it.

The default is 3 seconds.

The maximum allowed value is 900 seconds.

tracing_config

dictionary

Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.The functions AWS X-Ray tracing configuration.

To sample and record incoming requests, set Mode to Active.

mode

string

The tracing mode.

Choices:

  • "Active"

  • "PassThrough"

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)

vpc_config

dictionary

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.The VPC security groups and subnets that are attached to a Lambda function.

When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the functions VPC configuration.

The function can only access resources and the internet through that VPC.

security_group_ids

list / elements=string

A list of VPC security groups IDs.

subnet_ids

list / elements=string

A list of VPC subnet IDs.

wait

boolean

Wait for operation to complete before returning.

Choices:

  • false ← (default)

  • true

wait_timeout

integer

How many seconds to wait for an operation to complete before timing out.

Default: 320

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

Return Values

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

Key

Description

result

complex

When state=list, it is a list containing dictionaries of resource information.

Otherwise, it is a dictionary of resource information.

When state=absent, it is an empty dictionary.

Returned: always

identifier

string

The unique identifier of the resource.

Returned: success

properties

dictionary

The resource properties.

Returned: success

Authors

  • Ansible Cloud Team (@ansible-collections)