amazon.aws.lambda_layer module – Creates an AWS Lambda layer or deletes an AWS Lambda layer version
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_layer
.
New in amazon.aws 5.5.0
Synopsis
This module allows the management of AWS Lambda functions aliases via the Ansible
Creates an Lambda layer from a ZIP archive. Each time you call this module with the same layer name, a new version is created.
Deletes a version of an Lambda layer.
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 |
---|---|
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 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 |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
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. |
|
A list of compatible instruction set architectures. For example, x86_64. Mutually exclusive with |
|
The function layer archive. Required when Ignored when Mutually exclusive with o(version). |
|
The Amazon S3 bucket of the layer archive. |
|
The Amazon S3 key of the layer archive. |
|
For versioned objects, the version of the layer archive object to use. |
|
Path to the base64-encoded file of the layer archive. |
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The layer’s software license. It can be any of an SPDX license identifier, the URL of a license hosted on the internet or the full text of the license. Ignored when Mutually exclusive with |
|
The name or Amazon Resource Name (ARN) of the Lambda layer. |
|
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 The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
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 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 |
|
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 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 |
|
Determines if an Lambda layer should be created, or deleted. When set to Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
The version number of the layer to delete. Set to Required when Ignored when Mutually exclusive with |
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
---
# Create a new Python library layer version from a zip archive located into a S3 bucket
- name: Create a new python library layer
amazon.aws.lambda_layer:
state: present
name: sample-layer
description: 'My Python layer'
content:
s3_bucket: 'lambda-layers-us-west-2-123456789012'
s3_key: 'python_layer.zip'
compatible_runtimes:
- python3.6
- python3.7
license_info: MIT
compatible_architectures:
- x86_64
# Create a layer version from a zip in the local filesystem
- name: Create a new layer from a zip in the local filesystem
amazon.aws.lambda_layer:
state: present
name: sample-layer
description: 'My Python layer'
content:
zip_file: 'python_layer.zip'
compatible_runtimes:
- python3.6
- python3.7
license_info: MIT
compatible_architectures:
- x86_64
# Delete a layer version
- name: Delete a layer version
amazon.aws.lambda_layer:
state: absent
name: sample-layer
version: 2
# Delete all versions of test-layer
- name: Delete all versions
amazon.aws.lambda_layer:
state: absent
name: test-layer
version: -1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Info about the layer version that was created or deleted. Returned: always |
|
A list of compatible instruction set architectures. Returned: if it was defined for the layer version. |
|
A list of compatible runtimes. Returned: if it was defined for the layer version. Sample: |
|
Details about the layer version. Returned: |
|
The SHA-256 hash of the layer archive. Returned: Sample: |
|
A link to the layer archive in Amazon S3 that is valid for 10 minutes. Returned: Sample: |
|
The Amazon Resource Name (ARN) of a signing job. Returned: When a signing profile is defined |
|
The Amazon Resource Name (ARN) for a signing profile version. Returned: When a signing profile is defined |
|
The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). Returned: if the layer version exists or has been created Sample: |
|
The description of the version. Returned: |
|
The ARN of the layer. Returned: if the layer version exists or has been created Sample: |
|
The ARN of the layer version. Returned: if the layer version exists or has been created Sample: |
|
The layer’s software license. Returned: if it was defined for the layer version. Sample: |
|
The version number. Returned: if the layer version exists or has been created Sample: |