amazon.aws.lambda_event 模块 – 创建、更新或删除 AWS Lambda 函数事件映射
注意
此模块是 amazon.aws 集合（版本 9.0.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install amazon.aws。 您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：amazon.aws.lambda_event。
amazon.aws 5.0.0 中的新增功能
概要
此模块允许通过 Ansible 框架管理 AWS Lambda 函数事件源映射，例如 DynamoDB 和 Kinesis 流事件。 这些事件源映射仅在 AWS Lambda 拉取模型中相关，其中 AWS Lambda 调用该函数。 它是幂等的并支持“检查”模式。 使用模块 amazon.aws.lambda 管理 lambda 函数本身，并使用 amazon.aws.lambda_alias 管理函数别名。
此模块最初在 1.0.0 版本中添加到
community.aws。
要求
执行此模块的主机上需要以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
|---|---|
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 和 profile 选项是互斥的。 aws_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
函数别名的名称。 与 |
|
用于验证 SSL 证书的 CA 包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
使用 也可以使用 选项
|
|
连接的 URL，用于替代默认的 AWS 终端节点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
触发 Lambda 函数的事件的来源。 对于 DynamoDB 和 Kinesis 事件，请选择 对于 SQS 队列，请选择 选项
|
|
Lambda 函数的名称或 ARN。 |
|
用于身份验证的已命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
AWS 秘密访问密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 secret_key 和 profile 选项互斥。 aws_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
用于临时凭据的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
事件源所需的子参数。 |
|
AWS Lambda 在调用您的函数时将从您的事件源检索的最大记录数。 Amazon Kinesis - 默认值 Amazon DynamoDB Streams - 默认值 Amazon Simple Queue Service - 默认值 Amazon Managed Streaming for Apache Kafka - 默认值 自托管 Apache Kafka - 默认值 Amazon MQ（ActiveMQ 和 RabbitMQ）- 默认值 DocumentDB - 默认值 |
|
指示 AWS Lambda 是否应开始轮询或从事件源读取。 选项
|
|
（Streams 和 Amazon SQS）应用于事件源映射的当前响应类型枚举的列表。 选项
|
|
Lambda 在调用函数之前花费的最大时间（以秒为单位）来收集记录。 您可以将 对于流和 Amazon SQS 事件源，当
|
|
作为事件源的 SQS 队列、Kinesis 流或 DynamoDB 流的 Amazon 资源名称 (ARN)。 |
|
描述所需的状态。 选项
|
|
当设置为 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项
|
|
说明
注意
警告：对于模块，环境变量和配置文件是从 Ansible “host” 上下文读取的，而不是从“controller” 上下文读取的。因此，可能需要将文件显式复制到“host”。对于查找和连接插件，环境变量和配置文件是从 Ansible “controller” 上下文读取的，而不是从“host” 上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible “主机” 上下文（通常是
~/.aws/credentials）的配置文件中读取凭证和其他设置（例如区域）的默认值。有关详细信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。
示例
# Example that creates a lambda event notification for a DynamoDB stream
- name: DynamoDB stream event mapping
amazon.aws.lambda_event:
state: present
event_source: stream
function_name: "{{ function_name }}"
alias: Dev
source_params:
source_arn: arn:aws:dynamodb:us-east-1:123456789012:table/tableName/stream/2016-03-19T19:51:37.457
enabled: true
batch_size: 100
starting_position: TRIM_HORIZON
register: event
# Example that creates a lambda event notification for a DynamoDB stream
- name: DynamoDB stream event mapping
amazon.aws.lambda_event:
state: present
event_source: stream
function_name: "{{ function_name }}"
source_params:
source_arn: arn:aws:dynamodb:us-east-1:123456789012:table/tableName/stream/2016-03-19T19:51:37.457
enabled: true
batch_size: 100
starting_position: LATEST
function_response_types:
- ReportBatchItemFailures
register: event
- name: Show source event
ansible.builtin.debug:
var: event.lambda_stream_events
返回值
常见的返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
API 返回的描述流事件映射的字典 返回: 成功 |
|
Lambda 拉取的每个批次中的最大记录数。 返回: 总是 |
|
如果函数返回错误，则将批次分成两部分并重试。 返回: 仅适用于 Kinesis 和 DynamoDB Streams 示例: |
|
指定 Lambda 处理事件后事件目标的配置对象。 返回: 仅适用于 Kinesis、DynamoDB Streams、Amazon MSK 和自管理 Kafka |
|
失败调用的目标配置。 返回: 成功 |
|
目标资源 ARN。 返回: 成功 |
|
失败调用的目标配置。 返回: 成功 |
|
目标资源 ARN。 返回: 成功 |
|
事件源的 Amazon 资源名称 (ARN)。 返回: 总是 示例: |
|
Lambda 函数的 ARN。 返回: 总是 示例: |
|
应用于事件源映射的当前响应类型枚举列表。 返回: 适用于 Kinesis、DynamoDB Streams 和 Amazon SQS 示例: |
|
上次更新事件源映射或其状态更改的日期。 返回: 总是 示例: |
|
您的函数的上次 Lambda 调用的结果。 返回: 总是 示例: |
|
Lambda 在调用函数之前花费的最大时间（以秒为单位）来收集记录。 返回: 总是 示例: |
|
放弃早于指定年龄的记录。默认值为无限 (-1)。 返回: 仅适用于 Kinesis 和 DynamoDB Streams 示例: |
|
在指定次数的重试后放弃记录。 返回: 仅适用于 Kinesis 和 DynamoDB Streams 示例: |
|
从每个分片并发处理的批次数。 返回: 仅适用于 Kinesis 和 DynamoDB Streams 示例: |
|
从哪个位置开始读取流。 返回: 仅适用于 Kinesis 和 DynamoDB Streams 示例: |
|
事件源映射的状态。 返回: 总是 示例: |
|
指示用户或 Lambda 是否对事件源映射进行了上次更改。 返回: 总是 示例: |
|
用于 DynamoDB 和 Kinesis Streams 事件源的处理窗口的持续时间（以秒为单位）。 返回: 仅适用于 Kinesis 和 DynamoDB Streams 示例: |
|
事件源映射的标识符。 返回: 总是 示例: |