amazon.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。

amazon.aws 5.0.0 中的新增功能

概要

• 允许管理 Lambda 函数。

• 此模块最初在 1.0.0 版本中添加到 community.aws。

要求

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

• 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_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次递减。 aws_access_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，aws_access_key_id 别名在 5.1.0 版本中添加。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的发行版中删除。 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的发行版中删除。
architecture 别名：architectures 字符串 amazon.aws 5.0.0 中新增	函数支持的指令集体系结构。 需要 s3_bucket 或 zip_file 之一。 选项 "x86_64" "arm64"
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。
dead_letter_arn 字符串	包含 Amazon SQS 队列或 Amazon SNS 主题的目标 Amazon 资源名称 (ARN) 的父对象。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
description 字符串	简短的用户定义函数描述。Lambda 不使用此值。根据需要分配有意义的描述。 默认值： ""
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的发行版中删除。 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的发行版中删除。
environment_variables 字典	Lambda 函数获得的环境变量字典。
handler 字符串	代码中 Lambda 调用以开始执行的函数。
image_uri 字符串 amazon.aws 7.3.0 中新增	要使用的镜像的 Amazon ECR URI。 创建函数时需要（作为 runtime zip_file 和 s3_bucket 的替代方案）。 当 state=present 时需要。
kms_key_arn 字符串 community.aws 3.3.0 中新增	用于加密函数环境变量的 KMS 密钥 ARN。
layers 列表 / 元素=字典 amazon.aws 5.5.0 中新增	要添加到函数执行环境的函数层列表。 通过其 ARN 指定每个层，包括版本。
layer_name 别名：layer_arn 字符串	层的名称或 Amazon 资源名称 (ARN)。 与 layers.layer_version_arn 互斥。
layer_version_arn 字符串	层版本的 ARN。 与 layers.layer_name 互斥。
version 别名：layer_version 整数	版本号。 当提供layers.layer_name时需要，否则忽略。
memory_size 整数	分配给 Lambda 函数的内存大小（以 MB 为单位）。 默认值： 128
name 字符串 / 必需	您要分配给上传函数的名称。无法更改。
profile 别名：aws_profile 字符串	用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用AWS_PROFILE环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
purge_tags 布尔值	如果 purge_tags=true 并且设置了 tags，则将从资源中清除现有标签，以完全匹配 tags 参数定义的内容。 如果未设置 tags 参数，则即使 purge_tags=True，也不会修改标签。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，在 purge_tags 参数中将忽略它们。有关更多信息，请参见 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
region 别名：aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全球服务，将忽略 region。 也可以使用AWS_REGION 或 EC2_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 之后的一个版本中删除。
role 字符串	Lambda 在执行您的函数以访问任何其他 Amazon Web Services (AWS) 资源时假定的 IAM 角色的 Amazon 资源名称 (ARN)。如果角色属于同一个 AWS 账户，则可以使用裸 ARN。 当 state=present 时需要。
runtime 字符串	要上传的 Lambda 函数的运行时环境。 创建函数时必需。使用 boto3 文档中所述的参数。 当 state=present 时需要。 有关支持的运行时列表，请参见 https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html。
s3_bucket 字符串	存储包含部署包的 .zip 文件的 Amazon S3 存储桶名称。 如果 state=present，则必须存在 zip_file 或 s3_bucket。 s3_bucket 和 s3_key 必须一起使用。
s3_key 字符串	要上传的 Amazon S3 对象（部署包）键名。 s3_bucket 和 s3_key 必须一起使用。
s3_object_version 字符串	要上传的 Amazon S3 对象（部署包）版本。
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_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量（优先级递减）。 secret_key 和 profile 选项互斥。 为了与 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_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量（优先级递减）。 security_token 和 profile 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的一个版本中删除。 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中删除。
state 字符串	创建或删除 Lambda 函数。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
timeout 整数	函数在 Lambda 应终止函数之前的最大执行时间（以秒为单位）。 默认值： 3
tracing_mode 字符串	将模式设置为“Active”以使用 AWS X-Ray 对传入请求进行采样和跟踪。默认情况下关闭（设置为“PassThrough”）。 选项 "Active" "PassThrough"
validate_certs 布尔值	设置为 false 时，不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，可以考虑改用 aws_ca_bundle。 选项 false true ← (默认)
vpc_security_group_ids 列表 / 元素=字符串	要与 Lambda 函数关联的 VPC 安全组 ID 列表。 当使用 vpc_subnet_ids 时需要。
vpc_subnet_ids 列表 / 元素=字符串	在其中运行 Lambda 函数的子网 ID 列表。 如果您需要访问 VPC 中的资源，请使用此选项。如果您不想在 VPC 中运行函数，请留空。 如果已设置，则还必须设置 vpc_security_group_ids。
zip_file 别名：src 字符串	包含部署包的 .zip 文件 如果 state=present，则必须存在 zip_file 或 s3_bucket。

备注

注意

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

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

示例

# Create Lambda functions
- name: looped creation
  amazon.aws.lambda:
    name: '{{ item.name }}'
    state: present
    zip_file: '{{ item.zip_file }}'
    runtime: 'python2.7'
    role: 'arn:aws:iam::123456789012: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'
  loop:
    - 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 an empty dict
- name: remove tags
  amazon.aws.lambda:
    name: 'Lambda function'
    state: present
    zip_file: 'code.zip'
    runtime: 'python2.7'
    role: 'arn:aws:iam::123456789012:role/lambda_basic_execution'
    handler: 'hello_python.my_handler'
    tags: {}

# Basic Lambda function deletion
- name: Delete Lambda functions HelloWorld and ByeBye
  amazon.aws.lambda:
    name: '{{ item }}'
    state: absent
  loop:
    - HelloWorld
    - ByeBye

# Create Lambda functions with function layers
- name: looped creation
  amazon.aws.lambda:
    name: 'HelloWorld'
    state: present
    zip_file: 'hello-code.zip'
    runtime: 'python2.7'
    role: 'arn:aws:iam::123456789012:role/lambda_basic_execution'
    handler: 'hello_python.my_handler'
    layers:
      - layer_version_arn: 'arn:aws:lambda:us-east-1:123456789012:layer:python27-env:7'

返回值

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

键	描述
code 字典	boto3 中 get_function 返回的 lambda 函数代码。 返回： 成功
location 字符串	您可以使用此预签名 URL 下载之前上传的函数 .zip 文件。 此 URL 有效期最长为 10 分钟。 返回： 成功 示例： "https://prod-04-2014-tasks.s3.us-east-1.amazonaws.com/snapshots/sample"
repository_type 字符串	您可以从中下载函数的存储库。 返回： 成功 示例： "S3"
configuration 字典	boto3 中 get_function 返回的 Lambda 函数配置元数据。 返回： 成功
architectures 列表 / 元素=字符串	函数支持的架构。 返回： 成功 示例： ["arm64"]
code_sha256 字符串	函数部署包的 SHA256 哈希值。 返回： 成功 示例： "zOAGfF5JLFuzZoSNirUtOrQp+S341IOA3BcoXXoaIaU="
code_size 整数	函数部署包的大小（以字节为单位）。 返回： 成功 示例： 123
dead_letter_config 字典	函数的死信队列。 返回： 当函数配置了死信队列时 示例： {"target_arn": "arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"}
target_arn 字符串	SQS 队列或 SNS 主题的 ARN。 返回： 当函数配置了死信队列时 示例： "arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"
description 字符串	函数的描述。 返回： 成功 示例： "My function"
environment 字典	函数的环境变量。 返回： 当存在环境变量时
error 字典	无法应用的环境变量的错误消息。 返回： 当应用环境变量时发生错误时
error_code 字符串	错误代码。 返回： 当应用环境变量时发生错误时
message 字符串	错误消息。 返回： 当应用环境变量时发生错误时
variables 字典	环境变量键值对。 返回： 当存在环境变量时 示例： {"key": "value"}
function_arn 字符串	函数的 Amazon 资源名称 (ARN)。 返回： 成功时 示例： "arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"
function_name 字符串	函数的名称。 返回： 成功时 示例： "myFunction"
handler 字符串	Lambda 函数调用以开始执行您的函数。 返回： 成功时 示例： "index.handler"
last_modified 字符串	函数上次更新的日期和时间，采用 ISO-8601 格式 (YYYY-MM-DDThh:mm:ssTZD)。 返回： 成功时 示例： "2017-08-01T00:00:00.000+0000"
layers complex amazon.aws 5.5.0 中新增	函数的层。 返回： 成功时
arn 字符串	函数层的 Amazon 资源名称 (ARN)。 返回： 始终返回 示例： "active"
code_size 字符串	层归档的大小（以字节为单位）。 返回： 始终返回
signing_job_arn 字符串	签名作业的 Amazon 资源名称 (ARN)。 返回： 始终返回
signing_profile_version_arn 字符串	签名配置文件版本的 Amazon 资源名称 (ARN)。 返回： 始终返回
memory_size 整数	分配给函数的内存。 返回： 成功时 示例： 128
revision_id 字符串	函数或别名的最新更新版本。 返回： 成功时 示例： "a2x9886d-d48a-4a0c-ab64-82abc005x80c"
role 字符串	函数的执行角色。 返回： 成功时 示例： "arn:aws:iam::123456789012:role/lambda_basic_execution"
runtime 字符串	Lambda 函数的运行时环境。 返回： 成功时 示例： "nodejs6.10"
timeout 整数	Lambda 允许函数运行的时间（以秒为单位），超过此时间将终止函数。 返回： 成功时 示例： 3
tracing_config 字典	函数的 AWS X-Ray 追踪配置。 返回： 成功时 示例： {"mode": "Active"}
mode 字符串	追踪模式。 返回： 成功时 示例： "Active"
version 字符串	Lambda 函数的版本。 返回： 成功时 示例： "1"
vpc_config 字典	函数的网络配置。 返回： 成功时 示例： {"security_group_ids": [], "subnet_ids": [], "vpc_id": "123"}

作者

• Steyn Huizinga (@steynovich)

收藏链接

• 问题追踪器
• 存储库（源代码）
• 通信