amazon.aws.ec2_tag 模块 – 在 ec2 资源上创建和删除标签

注意

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

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

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

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

amazon.aws 1.0.0 中的新增功能

概要 

创建、修改和删除任何 EC2 资源的标签。
资源通过其资源 ID 引用（例如，实例为 i-XXXXXXX，VPC 为 vpc-XXXXXXX）。
此模块设计为与复杂参数 (tags) 一起使用，请参阅示例。

要求 

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

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 之后的版本中删除。
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_tags 布尔值	是否应从资源中删除未指定的标签。请注意，当与 `state=absent` 结合使用时，指定了但值不匹配的标签不会被清除。选项 `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 之后的版本中删除。
resource string / 必填	EC2 资源 ID。
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 保持一致，aws_secret_access_key 别名在 5.1.0 版本中添加。 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 字符串	标签应该在资源上存在还是不存在。在 1.0.0 版本中，使用 `state=list` 查询实例标签已被弃用，在 4.0.0 版本中不再可用。“list” 功能已移至专用模块 amazon.aws.ec2_tag_info。选项 `"present"` ← (默认) `"absent"`
tags dictionary / 必填	要添加到资源或从资源中删除的标签字典。如果未设置键的值，且使用了 `state=absent`，则无论其当前值如何，都将删除该标签。
validate_certs 布尔值	当设置为 `false` 时，与 AWS API 通信时将不验证 SSL 证书。强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。选项 `false` `true` ← (默认)

注释 

注意

注意： 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文中读取的，而不是从 “控制器” 上下文中读取的。因此，可能需要将文件显式复制到 “主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文中读取的，而不是从 “主机” 上下文中读取的。
Ansible 使用的 AWS SDK (boto3) 也可能从其在 Ansible “主机” 上下文（通常为 ~/.aws/credentials）中的配置文件读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例 

- name: Ensure tags are present on a resource
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: vol-XXXXXX
    state: present
    tags:
      Name: ubervol
      env: prod

- name: Ensure all volumes are tagged
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: '{{ item.id }}'
    state: present
    tags:
      Name: dbserver
      Env: production
  loop: '{{ ec2_vol.volumes }}'

- name: Remove the Env tag
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: i-xxxxxxxxxxxxxxxxx
    tags:
      Env:
    state: absent

- name: Remove the Env tag if it's currently 'development'
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: i-xxxxxxxxxxxxxxxxx
    tags:
      Env: development
    state: absent

- name: Remove all tags except for Name from an instance
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: i-xxxxxxxxxxxxxxxxx
    tags:
      Name: ''
    state: absent
    purge_tags: true

返回值 

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

键	描述
added_tags 字典	添加到资源的标签字典。返回: 如果添加了标签
removed_tags 字典	从资源中删除的标签字典。返回: 如果删除了标签
tags 字典	包含资源上标签的字典。返回: 始终

作者

Lester Wade (@lwade)
Paul Arthur (@flowerysong)