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

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：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

string

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

path

用于验证 SSL 证书的 CA 捆绑包的位置。

也可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

dictionary

用于修改 botocore 配置的字典。

参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。

debug_botocore_endpoint_logs

boolean

使用 botocore.endpoint 记录器来解析任务期间发出的唯一（而不是总共的）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出到 playbook 期间生成的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

ec2_elbs

list / elements=string

ELB 名称列表

当 state=present 时是必需的。

enable_availability_zone

boolean

如果要启用实例在目标 ELB 上的可用区，如果该可用区尚未启用。

如果 enable_availability_zone=no，如果可用区未在 ELB 上启用，任务将失败。

选项

  • false

  • true ← (默认)

endpoint_url

别名：ec2_url, aws_endpoint_url, s3_url

string

连接到此 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

string / required

EC2 实例 ID。

profile

别名：aws_profile

string

用于身份验证的命名 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

string

要使用的 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 之后的版本中删除。

secret_key

别名：aws_secret_access_key, aws_secret_key, ec2_secret_key

string

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

string

用于临时凭证的 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

string / required

注册或注销实例。

选项

  • "present"

  • "absent"

validate_certs

boolean

设置为 false 时，与 AWS API 通信时将不会验证 SSL 证书。

强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。

选项

  • false

  • true ← (默认)

wait

boolean

等待实例注册或注销成功完成后再返回。

选项

  • 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

返回值

通用返回值记录在此处 此处，以下是此模块独有的字段

键

描述

updated_elbs

list / elements=string

已将实例添加或从中删除的 ELB 名称的列表。

返回： 始终

作者

  • John Jarvis (@jarv)