amazon.aws.cloudwatchlogs_log_group 模块 – 在 CloudWatchLogs 中创建或删除日志组

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 需求 以了解详情。

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

amazon.aws 5.0.0 中的新增功能

概要

• 在 CloudWatchLogs 中创建或删除日志组。

• 此模块最初是在 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
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 后的某个版本中删除。
kms_key_id 字符串	加密日志数据时使用的 CMK 的 Amazon 资源名称 (ARN)。
log_group_name 字符串 / 必需	日志组的名称。
overwrite 布尔值	在创建时是否应覆盖现有日志组。 与 purge_retention_policy 互斥。 选项 false ← (默认) true
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_retention_policy 布尔值	是否清除保留策略。 与retention和overwrite互斥。 选项 false ← (默认) true
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 等全局服务，将忽略区域。 也可以使用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 之后的一个版本中删除。
retention 整数	在指定的日志组中保留日志事件的天数。 有效值为：[1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653] 与 purge_retention_policy 互斥。
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 字符串	规则是否存在。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置tags参数，则不会修改标签。
validate_certs 布尔值	设置为false时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑改为设置aws_ca_bundle。 选项 false true ← (默认)

注释

注意

• 有关参数和返回值的详细信息，请参阅http://boto3.readthedocs.io/en/latest/reference/services/logs.html。

• 在 4.0.0 版本中添加了对purge_tags的支持。

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

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

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- amazon.aws.cloudwatchlogs_log_group:
    log_group_name: test-log-group

- amazon.aws.cloudwatchlogs_log_group:
    state: present
    log_group_name: test-log-group
    tags:
      Name: "test-log-group"
      Env: "QA"

- amazon.aws.cloudwatchlogs_log_group:
    state: present
    log_group_name: test-log-group
    tags:
      Name: "test-log-group"
      Env: QA
    kms_key_id: arn:aws:kms:region:account-id:key/key-id

- amazon.aws.cloudwatchlogs_log_group:
    state: absent
    log_group_name: test-log-group

返回值

公共返回值已记录此处，以下是此模块特有的字段

键	描述
arn 字符串	日志组的 Amazon 资源名称 (ARN)。 返回：始终
creation_time 整数	日志组的创建时间。 返回：始终
kms_key_id 字符串	加密日志数据时使用的 CMK 的 Amazon 资源名称 (ARN)。 返回：始终
log_group_name 字符串	日志组的名称。 返回：始终
log_groups 复杂的 在 community.aws 4.0.0 中添加	返回表示日志组的复杂对象的列表。 返回：成功
arn 字符串	日志组的 Amazon 资源名称 (ARN)。 返回：始终
creation_time 整数	日志组的创建时间。 返回：始终
kms_key_id 字符串	加密日志数据时使用的 CMK 的 Amazon 资源名称 (ARN)。 返回：始终
log_group_name 字符串	日志组的名称。 返回：始终
metric_filter_count 整数	指标筛选器的数量。 返回：始终
retention_in_days 整数	在指定的日志组中保留日志事件的天数。 返回：始终
stored_bytes 字符串	存储的字节数。 返回：始终
tags 字典	表示日志组上标签的字典。 返回：始终
metric_filter_count 整数	指标筛选器的数量。 返回：始终
retention_in_days 整数	在指定的日志组中保留日志事件的天数。 返回：始终
stored_bytes 字符串	存储的字节数。 返回：始终
tags 字典	表示日志组上标签的字典。 返回：始终

作者

• Willian Ricardo (@willricardo)

收藏链接

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