amazon.aws.cloudwatchevent_rule 模块 – 管理 CloudWatch 事件规则和目标

注意

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

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

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

要在 playbook 中使用它，请指定：amazon.aws.cloudwatchevent_rule。

amazon.aws 5.0.0 中的新增功能

概要

• 此模块创建和管理 CloudWatch 事件规则和目标。

• 此模块最初在 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 保持一致，在 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。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总数）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
description 字符串	规则的描述。
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 之后的一个版本中移除。
event_pattern JSON	用于匹配传入事件以确定是否应触发规则的字符串模式。
name 字符串 / 必需	您要创建、更新或删除的规则的名称。不允许使用空格或特殊字符（即必须匹配 [\.\-_A-Za-z0-9]+）。
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 选项是互斥的。
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_arn 字符串	与规则关联的 IAM 角色的 Amazon 资源名称 (ARN)。
schedule_expression 字符串	定义规则触发计划的 cron 或 rate 表达式。例如，cron(0 20 * * ? *), rate(5 minutes)。
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_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" ← (默认) "disabled" "absent"
targets 列表 / 元素=字典	要添加到规则或更新规则的目标列表。 默认值： []
arn 字符串 / 必需	与目标关联的 ARN。
ecs_parameters 字典	如果事件目标是 ECS 任务，则包含要使用的 ECS 任务定义和任务数量。
task_count 整数	基于任务定义要创建的任务数量。
task_definition_arn 字符串 / 必需	任务定义的完整 ARN。
id 字符串 / 必需	唯一的目标分配 ID。
input JSON	将覆盖传递到目标的事件数据的 JSON 对象。 如果没有指定 targets.input、targets.input_path 或 targets.input_transformer，则整个事件将以 JSON 格式传递到目标。
input_path 字符串	指定要传递到目标的事件数据部分的 JSONPath 字符串（例如 $.detail）。 如果没有指定 targets.input、targets.input_path 或 targets.input_transformer，则整个事件将以 JSON 格式传递到目标。
input_transformer 字典 在 community.aws 4.1.0 中添加	支持根据某些事件数据向目标提供自定义输入的设置。
input_paths_map 字典	指定事件数据转换为自定义输入参数的字典。
input_template JSON	一个字符串，它使用从事件数据中提取的 input_paths_map 模板化值。它用于生成要发送到目标的输出。
role_arn 字符串	触发规则时要用于此目标的 IAM 角色的 ARN。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

注释

注意

• 规则必须至少包含 event_pattern 或 schedule_expression。规则可以同时具有 event_pattern 和 schedule_expression，在这种情况下，规则将在匹配事件以及按计划触发。

• 指定目标时，targets.input、targets.input_path、targets.input_transformer.input_paths_map 和 targets.input_transformer.input_template 是互斥的可选参数。

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

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

示例

- amazon.aws.cloudwatchevent_rule:
    name: MyCronTask
    schedule_expression: "cron(0 20 * * ? *)"
    description: Run my scheduled task
    targets:
      - id: MyTargetId
        arn: arn:aws:lambda:us-east-1:123456789012:function:MyFunction

- amazon.aws.cloudwatchevent_rule:
    name: MyDisabledCronTask
    schedule_expression: "rate(5 minutes)"
    description: Run my disabled scheduled task
    state: disabled
    targets:
      - id: MyOtherTargetId
        arn: arn:aws:lambda:us-east-1:123456789012:function:MyFunction
        input: '{"foo": "bar"}'

- amazon.aws.cloudwatchevent_rule:
    name: MyInstanceLaunchEvent
    description: "Rule for EC2 instance launch"
    state: present
    event_pattern: '{"source":["aws.ec2"],"detail-type":["EC2 Instance State-change Notification"],"detail":{"state":["pending"]}}'
    targets:
      - id: MyTargetSnsTopic
        arn: arn:aws:sns:us-east-1:123456789012:MySNSTopic
        input_transformer:
          input_paths_map:
            instance: "$.detail.instance-id"
            state: "$.detail.state"
          input_template: "<instance> is in state <state>"

- amazon.aws.cloudwatchevent_rule:
    name: MyCronTask
    state: absent

返回值

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

键	描述
rule 字典	CloudWatch 事件规则数据。 返回：成功
arn 字符串	与规则关联的 ARN。 返回：成功 示例： "arn:aws:events:us-east-1:123456789012:rule/MyCronTask"
description 字符串	规则的描述。 返回：成功 示例： "运行我的计划任务"
name 字符串	您正在创建、更新或删除的规则的名称。 返回：成功 示例： "MyCronTask"
schedule_expression 字符串	定义规则触发计划的 cron 或 rate 表达式。 返回：成功 示例： "cron(0 20 * * ? *)"
state 字符串	规则是否存在（并启用）、禁用或不存在。 返回：成功 示例： "enabled"
targets 列表 / 元素=字典	分配给规则的 CloudWatch 事件目标。 返回：成功
arn 字符串	与目标关联的 ARN。 返回：成功 示例： "arn:aws:lambda:us-east-1:123456789012:function:MyFunction"
id 字符串	唯一的目标分配 ID。 返回：成功 示例： "MyTargetId"

作者

• Jim Dalton (@jsdalton)

相关链接

• 问题追踪器
• 代码仓库 (源代码)
• 沟通