amazon.aws.cloudwatchlogs_log_group 模块 – 在 CloudWatchLogs 中创建或删除 log_group

注意

此模块是 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 中创建或删除 log_group。
此模块最初在 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 等全局服务，将忽略 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 之后的版本中删除。
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

返回值 

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

Key	描述
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)