amazon.aws.lambda_layer 模块 – 创建 AWS Lambda 层或删除 AWS Lambda 层版本

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在 playbook 中使用它,请指定: amazon.aws.lambda_layer

amazon.aws 5.5.0 中的新增功能

概要

  • 此模块允许通过 Ansible 管理 AWS Lambda 函数别名

  • 从 ZIP 存档创建 Lambda 层。每次使用相同的层名称调用此模块时,都会创建一个新版本。

  • 删除 Lambda 层的一个版本。

要求

执行此模块的主机需要以下要求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名:aws_access_key_id、aws_access_key、ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

也可以使用 AWS_ACCESS_KEY_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量,优先级依次递减。

aws_access_keyprofile 选项是互斥的。

aws_access_key_id 别名在 5.1.0 版本中添加,以与 AWS botocore SDK 保持一致。

ec2_access_key 别名已弃用,将在 2024-12-01 之后的一个版本中移除。

EC2_ACCESS_KEY 环境变量的支持已弃用,并将 2024-12-01 之后的一个版本中移除。

aws_ca_bundle

路径

验证 SSL 证书时使用的 CA 捆绑包的位置。

也可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

字典

用于修改 botocore 配置的字典。

参数可在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config

compatible_architectures

列表 / 元素=字符串

兼容的指令集体系结构列表。例如,x86_64。

version 互斥。

compatible_runtimes

列表 / 元素=字符串

兼容的函数运行时列表。

state=absent 时忽略。

version 互斥。

content

字典

函数层存档。

state=present 时必需。

state=absent 时忽略。

与 version 互斥。

s3_bucket

字符串

层存档的 Amazon S3 存储桶。

s3_key

字符串

层存档的 Amazon S3 密钥。

s3_object_version

字符串

对于版本化的对象,要使用的层存档对象的版本。

zip_file

路径

层存档的 base64 编码文件的路径。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析在任务期间进行的唯一(而不是总计)"resource:action" API 调用,并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调来输出 playbook 期间进行的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

description

字符串

版本的描述。

state=absent 时忽略。

version 互斥。

endpoint_url

别名:ec2_url、aws_endpoint_url、s3_url

字符串

连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他兼容 AWS 的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。

也可以使用 AWS_URLEC2_URL 环境变量,优先级依次递减。

ec2_urls3_url 别名已弃用,将在 2024-12-01 之后的一个版本中移除。

EC2_URL 环境变量的支持已弃用,并将 2024-12-01 之后的一个版本中移除。

license_info

字符串

层的软件许可证。它可以是 SPDX 许可证标识符、互联网上托管的许可证的 URL 或许可证的全文。

state=absent 时忽略。

version 互斥。

name

别名:layer_name

字符串 / 必需

Lambda 层的名称或 Amazon 资源名称 (ARN)。

profile

别名:aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

更多关于命名配置文件的信息,请参见 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_keyaws_secret_keysecurity_token 选项互斥。

region

别名:aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全球服务,将忽略 region

也可以使用 AWS_REGIONEC2_REGION 环境变量。

更多信息,请参见 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

ec2_region 别名已弃用,将在 2024-12-01 之后的发行版中移除。

EC2_REGION 环境变量的支持已弃用,将在 2024-12-01 之后的发行版中移除。

secret_key

别名:aws_secret_access_key, aws_secret_key, ec2_secret_key

字符串

AWS 密钥访问密钥。

有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

也可以按优先级递减的顺序使用 AWS_SECRET_ACCESS_KEYAWS_SECRET_KEYEC2_SECRET_KEY 环境变量。

secret_keyprofile 选项互斥。

为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_secret_access_key 别名。

ec2_secret_key 别名已弃用,将在 2024-12-01 之后的发行版中移除。

EC2_SECRET_KEY 环境变量的支持已弃用,将在 2024-12-01 之后的发行版中移除。

session_token

别名:aws_session_token, security_token, aws_security_token, access_token

字符串

用于临时凭证的 AWS STS 会话令牌。

有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

也可以按优先级递减的顺序使用 AWS_SESSION_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN 环境变量。

security_tokenprofile 选项互斥。

在 3.2.0 版本中添加了 aws_session_tokensession_token 别名,在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token

security_tokenaws_security_tokenaccess_token 别名已弃用,将在 2024-12-01 之后的发行版中移除。

EC2_SECRET_KEYAWS_SECURITY_TOKEN 环境变量的支持已弃用,将在 2024-12-01 之后的发行版中移除。

state

字符串

确定是否应创建或删除 Lambda 层。设置为 present 时,将创建一个 Lambda 层版本。如果设置为 absent,则将删除现有的 Lambda 层版本。

选项

  • "absent"

  • "present" ← (默认)

validate_certs

布尔值

设置为 false 时,将不会验证与 AWS API 通信的 SSL 证书。

强烈建议不要设置 validate_certs=false,作为替代方案,请考虑改用 aws_ca_bundle

选项

  • false

  • true ← (默认)

version

整数

要删除的层的版本号。

设置为 -1 可删除指定层名称的所有版本。

state=absent 时为必需。

state=present 时被忽略。

descriptioncontentcompatible_runtimeslicense_infocompatible_architectures 互斥。

注释

注意

  • 警告:对于模块,环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此,可能需要显式地将文件复制到“主机”。对于查找和连接插件,环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。

  • Ansible 使用的 AWS SDK (boto3) 也可能从其在 Ansible“主机”上下文中的配置文件(通常为 ~/.aws/credentials)读取凭证和其他设置的默认值,例如区域。更多信息,请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

示例

---
# 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

返回值

常见返回值已在此处记录 此处,以下是此模块特有的字段

描述

layer_version

列表 / 元素=字典

关于已创建或删除的层版本的信息。

返回:始终

compatible_architectures

列表 / 元素=字符串

兼容指令集体系结构的列表。

返回:如果它已为层版本定义。

compatible_runtimes

列表 / 元素=字符串

兼容运行时的列表。

返回:如果它已为层版本定义。

示例: ["python3.7"]

content

复杂类型

关于层版本的详细信息。

返回:state=present

code_sha256

字符串

层归档的 SHA-256 哈希值。

返回:state=present

示例: "VLluleJZ3HTwDrdYolSMrS+8iPwEkcoXXaegjXf+dmc="

code_size

整数

层归档的大小(以字节为单位)。

返回:state=present

示例: 9473675

location

字符串

指向 Amazon S3 中的层归档的链接,有效期为 10 分钟。

返回:state=present

示例: "https://awslambda-us-east-1-layers.s3.us-east-1.amazonaws.com/snapshots/123456789012/pylayer-9da91deffd3b4941b8baeeae5daeffe4"

signing_job_arn

字符串

签名作业的 Amazon 资源名称 (ARN)。

返回:定义签名配置文件时

signing_profile_version_arn

字符串

签名配置文件版本的 Amazon 资源名称 (ARN)。

返回:定义签名配置文件时

created_date

字符串

创建层版本的日期,采用 ISO-8601 格式 (YYYY-MM-DDThh:mm:ss.sTZD)。

返回:如果层版本存在或已创建

示例: "2022-09-28T14:27:35.866+0000"

description

字符串

版本的描述。

返回:state=present

layer_arn

字符串

层的 ARN。

返回:如果层版本存在或已创建

示例: "arn:aws:lambda:eu-west-2:123456789012:layer:pylayer"

layer_version_arn

字符串

层版本的 ARN。

返回:如果层版本存在或已创建

示例: "arn:aws:lambda:eu-west-2:123456789012:layer:pylayer:2"

license_info

字符串

层的软件许可证。

返回:如果它已为层版本定义。

示例: "GPL-3.0-only"

version

整数

版本号。

返回:如果层版本存在或已创建

示例: 1

作者

  • Aubin Bikouo (@abikouo)