community.aws.s3_bucket_notification 模块 – 创建、更新或删除针对 Lambda 函数、SNS 或 SQS 的 S3 存储桶通知。

注意

此模块是 community.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：community.aws.s3_bucket_notification。

community.aws 1.0.0 中的新功能

概要

• 此模块支持创建、更新和删除针对 Lambda 函数、SNS 主题或 SQS 队列的 S3 存储桶通知配置文件。

• 通知的目标必须已经存在。对于 Lambda，请使用模块 community.aws.lambda 来管理 Lambda 函数本身，使用 community.aws.lambda_alias 来管理函数别名，并使用 community.aws.lambda_policy 来修改 Lambda 权限。对于 SNS 或 SQS，请使用 community.aws.sns_topic 或 community.aws.sqs_queue。

要求

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

• 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 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 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。
bucket_name 字符串 / 必选	S3 存储桶名称。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出 playbook 期间的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ←（默认） true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
event_name 字符串 / 必选	存储桶上事件通知的唯一名称。
events list / elements=string	将触发通知的事件。您可以选择多个事件发送到同一目标，您可以设置不同的事件发送到不同的目标，并且可以为事件设置前缀或后缀。但是，对于每个存储桶，单个事件不能具有多个配置，这些配置具有可能匹配相同对象键的重叠前缀或后缀。 当 state=present 时为必填项。 选项 "s3:ObjectCreated:*" "s3:ObjectCreated:Put" "s3:ObjectCreated:Post" "s3:ObjectCreated:Copy" "s3:ObjectCreated:CompleteMultipartUpload" "s3:ObjectRemoved:*" "s3:ObjectRemoved:Delete" "s3:ObjectRemoved:DeleteMarkerCreated" "s3:ObjectRestore:Post" "s3:ObjectRestore:Completed" "s3:ReducedRedundancyLostObject" 默认值： []
lambda_alias 字符串	Lambda 函数别名的名称。 与 lambda_version 互斥。
lambda_function_arn 别名：function_arn 字符串	lambda 函数的 ARN。 与 queue_arn 和 topic_arn 互斥。
lambda_version 整数	Lambda 函数的版本。 与 lambda_alias 互斥。 默认值： 0
prefix 字符串	可选前缀，用于将通知限制为键以匹配字符开头的对象。 默认值： ""
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 选项互斥。
queue_arn 字符串 在 community.aws 3.2.0 中添加	SQS 队列的 ARN。 与 topic_arn 和 lambda_function_arn 互斥。
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 之后的版本中删除。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS secret access key。 有关访问令牌的更多信息，请参阅 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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 选项互斥。 别名 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 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
state 字符串	描述所需状态。 选项 "present" ← (默认) "absent"
suffix 字符串	可选后缀，用于将通知限制为键以匹配字符结尾的对象。 默认值： ""
topic_arn 字符串 在 community.aws 3.2.0 中添加	SNS 主题的 ARN。 与 queue_arn 和 lambda_function_arn 互斥。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

注意

注意

• 如果使用 Lambda 函数作为目标，则还需要 Lambda 策略，请使用 community.aws.lambda_policy 来允许通知的 lambda:InvokeFunction。

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

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

示例

---
# Examples adding notification target configs to a S3 bucket
- name: Setup bucket event notification to a Lambda function
  community.aws.s3_bucket_notification:
    state: present
    event_name: on_file_add_or_remove
    bucket_name: test-bucket
    lambda_function_arn: arn:aws:lambda:us-east-2:123456789012:function:test-lambda
    events: ["s3:ObjectCreated:*", "s3:ObjectRemoved:*"]
    prefix: images/
    suffix: .jpg

- name: Setup bucket event notification to SQS
  community.aws.s3_bucket_notification:
    state: present
    event_name: on_file_add_or_remove
    bucket_name: test-bucket
    queue_arn: arn:aws:sqs:us-east-2:123456789012:test-queue
    events: ["s3:ObjectCreated:*", "s3:ObjectRemoved:*"]
    prefix: images/
    suffix: .jpg

# Example removing an event notification
- name: Remove event notification
  community.aws.s3_bucket_notification:
    state: absent
    event_name: on_file_add_or_remove
    bucket_name: test-bucket

返回值

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

键	描述
notification_configuration 复杂	当前应用的通知字典 返回：成功
lambda_function_configurations list / elements=string	应用于存储桶的当前 Lambda 函数通知配置列表。 返回：成功
queue_configurations list / elements=string	应用于存储桶的当前 SQS 通知配置列表。 返回：成功
topic_configurations list / elements=string	应用于存储桶的当前 SNS 通知配置列表。 返回：成功

作者

• XLAB d.o.o. (@xlab-si)

• Aljaz Kosir (@aljazkosir)

• Miha Plesko (@miha-plesko)

• Mark Woolley (@marknet15)

合集链接

• 问题跟踪器
• 存储库（源代码）
• 交流