community.aws.elb_instance 模块 – 从 EC2 ELB 注销或注册实例

注意

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

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

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

要在剧本中使用它，请指定：community.aws.elb_instance。

community.aws 1.0.0 中的新增功能

概要 

此模块从其所属的 ELB 注销或注册 AWS EC2 实例。
只有在找到要操作的 ELB 时，才会被标记为已更改。

别名：ec2_elb

要求 

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

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_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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` 回调将输出到剧本期间进行的总列表。也可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选项 `false` ← (默认) `true`
ec2_elbs 列表 / 元素=字符串	ELB 名称列表当 state=present 时必需。
enable_availability_zone 布尔值	如果尚未启用可用区，是否在目标 ELB 上启用实例的可用区。如果 enable_availability_zone=no，如果 ELB 上未启用可用区，则任务将失败。选项 `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 之后的一个版本中删除。
instance_id 字符串 / 必需	EC2 实例 ID。
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），将忽略区域。也可以使用`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 密钥。有关访问令牌的更多信息，请参阅 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" (不存在)`
验证证书 (validate_certs) 布尔值	设置为`false`时，将不会验证与 AWS API 通信的 SSL 证书。强烈建议不要设置validate_certs=false，可以考虑改为设置aws_ca_bundle。选项 `false` `true` ← (默认)
等待 (wait) 布尔值	等待实例注册或注销成功后再返回。选项 `false` `true` ← (默认)
等待超时 (wait_timeout) 整数 (integer)	等待实例更改状态的秒数。如果wait_timeout=0，则如果发生短暂错误，此模块可能会返回错误。如果非零，则忽略任何短暂错误，直到达到超时时间。当wait=no时忽略。默认值：`0`

备注 

注意

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

示例 

# basic pre_task and post_task example
pre_tasks:
  - name: Instance De-register
    community.aws.elb_instance:
      instance_id: "{{ ansible_ec2_instance_id }}"
      state: absent
    register: deregister_instances
    delegate_to: localhost
roles:
  - myrole
post_tasks:
  - name: Instance Register
    community.aws.elb_instance:
      instance_id: "{{ ansible_ec2_instance_id }}"
      ec2_elbs: "{{ deregister_instances.updated_elbs }}"
      state: present
    delegate_to: localhost

返回值 

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

键 (Key)	描述
更新的 ELB (updated_elbs) 列表 / 元素=字符串	已向其添加或从中移除实例的 ELB 名称列表。返回：始终

作者

John Jarvis (@jarv)