community.aws.opensearch_info 模块 – 获取一个或多个 OpenSearch 或 ElasticSearch 域的信息

注意

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

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

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

要在 playbook 中使用它，请指定：community.aws.opensearch_info。

community.aws 4.0.0 中的新功能

概要

  • 获取有关一个 Amazon OpenSearch Service 域的信息。

要求

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

  • 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 回调来输出 playbook 期间执行的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ←（默认）

  • true

domain_name

字符串

Amazon OpenSearch/ElasticSearch Service 域的名称。

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 选项互斥。

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

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 选项是互斥的。

别名 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 之后的版本中移除。

tags

字典

用于过滤与所有标签键值对匹配的 OpenSearch 域的标签字典。

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

Notes

注意

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

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

Examples

- name: Get information about an OpenSearch domain instance
  community.aws.opensearch_info:
    domain_name: my-search-cluster
  register: new_cluster_info

- name: Get all OpenSearch instances
  community.aws.opensearch_info:

- name: Get all OpenSearch instances that have the specified Key, Value tags
  community.aws.opensearch_info:
    tags:
      Applications: search
      Environment: Development

Return Values

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

Key

描述

instances

复杂类型

OpenSearch 域实例列表

返回: 总是

domain_config

复杂类型

OpenSearch 域配置

返回: 总是

domain_name

字符串

OpenSearch 域的名称。

返回: 总是

domain_status

复杂类型

OpenSearch 域的当前状态。

返回: 总是

access_policies

复杂类型

IAM 访问策略，为 JSON 格式的字符串。

返回: 成功

advanced_security_options

复杂类型

指定高级安全选项。

返回: 成功

enabled

布尔值

如果启用了高级安全性，则为 True。

您必须启用节点到节点加密才能使用高级安全选项。

返回: 成功

internal_user_database_enabled

布尔值

如果启用了内部用户数据库，则为 True。

返回: 成功

master_user_options

复杂类型

主用户的凭据，用户名和密码，ARN 或两者。

返回: 成功

master_user_arn

字符串

主用户的 ARN（如果启用了 IAM）。

返回: 成功

master_user_name

字符串

主用户的用户名，存储在 Amazon OpenSearch Service 域内部数据库中。

返回: 成功

master_user_password

字符串

主用户的密码，存储在 Amazon OpenSearch Service 域内部数据库中。

返回: 成功

saml_options

复杂类型

域的 SAML 应用程序配置。

返回: 成功

enabled

布尔值

如果启用了 SAML，则为 True。

返回: 成功

idp

复杂类型

SAML 身份提供商的信息。

返回: 成功

entity_id

字符串

SAML 身份提供商中应用程序的唯一实体 ID。

返回: 成功

metadata_content

字符串

SAML 应用程序的 XML 格式的元数据。

返回: 成功

master_backend_role

字符串

SAML 主用户映射到的后端角色。

返回: 成功

master_user_name

字符串

SAML 主用户名，存储在 Amazon OpenSearch Service 域内部数据库中。

返回: 成功

roles_key

字符串

用于后端角色的 SAML 断言元素。默认为 roles。

返回: 成功

session_timeout_minutes

整数

用户会话变为非活动状态的持续时间（以分钟为单位）。可接受的值介于 1 到 1440 之间，默认值为 60。

返回: 成功

subject_key

字符串

用于用户名的 SAML 断言元素。默认为 NameID。

返回: 成功

arn

字符串

OpenSearch 域的 ARN。

返回: 总是

auto_tune_options

复杂类型

指定 Auto-Tune 选项。

返回: 成功

desired_state

字符串

Auto-Tune 的所需状态。有效值为 ENABLED 和 DISABLED。

返回: 成功

maintenance_schedules

列表 / 元素=字典

维护计划列表。

返回: 成功

cron_expression_for_recurrence

字符串

用于重复维护计划的 cron 表达式。

返回: 成功

duration

复杂类型

指定维护计划持续时间、持续时间值和持续时间单位。

返回: 成功

unit

字符串

维护计划持续时间的单位。有效值为 HOURS。

返回: 成功

value

整数

指定维护计划持续时间值的整数。

返回: 成功

start_at

字符串

Auto-Tune 维护计划开始的时间戳。

返回: 成功

cluster_config

复杂类型

OpenSearch Service 域的集群配置参数。

返回: 成功

availability_zone_count

整数

一个整数值，指示在启用区域感知时域的可用区数量。如果启用了 VPC 端点，则应等于子网数。

返回: 成功

cold_storage_options

复杂类型

指定域的 ColdStorageOptions 配置。

返回: 成功

enabled

布尔值

启用冷存储时为 True。支持 Elasticsearch 7.9 或更高版本。

返回: 成功

dedicated_master_count

整数

域的专用主节点（活动和备用）的总数。

返回: 成功

dedicated_master_enabled

布尔值

一个布尔值，指示是否启用了专用主节点。

返回: 成功

dedicated_master_type

字符串

专用主节点的实例类型。

返回: 成功

instance_count

整数

域的实例数。

返回: 成功

instance_type

字符串

用于域的实例类型。

返回: 成功

warm_count

整数

域中 UltraWarm 节点的数量。

返回: 成功

warm_enabled

布尔值

启用 UltraWarm 存储时为 True。

返回: 成功

warm_type

字符串

OpenSearch 域的温节点的实例类型。

返回: 成功

zone_awareness

布尔值

一个布尔值，指示是否启用了区域感知。

返回: 成功

zone_awareness_config

复杂类型

启用区域感知时域的区域感知配置。

返回: 成功

availability_zone_count

整数

一个整数值，指示在启用区域感知时域的可用区数量。

返回: 成功

zone_awareness_enabled

布尔值

一个布尔值，指示是否启用了区域感知。

返回: 成功

cognito_options

复杂类型

将 OpenSearch Service 配置为使用 Amazon Cognito 身份验证进行 OpenSearch Dashboards 的参数。

返回: 成功

enabled

布尔值

为 OpenSearch Dashboards 身份验证启用 Cognito 的选项。

返回: 成功

identity_pool_id

字符串

用于 OpenSearch Dashboards 身份验证的 Cognito 身份池 ID。

返回: 成功

role_arn

字符串

为访问 Cognito 资源提供 OpenSearch 权限的角色 ARN。

返回: 成功

user_pool_id

字符串

用于 OpenSearch Dashboards 身份验证的 Cognito 用户池 ID。

返回: 成功

created

布尔值

域创建状态。如果域的创建已完成，则为 True。如果域创建仍在进行中，则为 False。

返回: 总是

deleted

布尔值

域删除状态。如果已收到域的删除请求但资源清理仍在进行中，则为 True。如果该域尚未删除，则为 False。域删除完成后，不再返回该域的状态。

返回: 总是

domain_endpoint_options

复杂类型

用于指定将应用于域端点的配置的选项。

返回: 成功

custom_endpoint

字符串

自定义端点的完全限定域名。

返回: 成功

custom_endpoint_certificate_arn

字符串

自定义端点的 ACM 证书 ARN。

返回: 成功

custom_endpoint_enabled

布尔值

是否为域启用自定义端点。

返回: 成功

enforce_https

布尔值

是否仅应为域启用 HTTPS 端点。

返回: 成功

tls_security_policy

字符串

指定应用于域的 HTTPS 端点的 TLS 安全策略。

返回: 成功

domain_id

字符串

OpenSearch 域的唯一标识符。

返回: 总是

domain_name

字符串

OpenSearch 域的名称。

返回: 总是

ebs_options

复杂类型

配置 OpenSearch Service 域的基于 EBS 的存储的参数。

返回: 成功

ebs_enabled

布尔值

指定是否启用基于 EBS 的存储。

返回: 成功

iops

整数

预配置 IOPS EBS 卷 (SSD) 的 IOPD。

返回: 成功

volume_size

整数

指定 EBS 卷大小的整数。

返回: 成功

volume_type

字符串

指定基于 EBS 的存储的卷类型。“standard”|”gp2”|”io1”

返回: 成功

encryption_at_rest_options

复杂类型

启用静态加密的参数。

返回: 成功

enabled

布尔值

是否应静态加密数据。

返回: 成功

kms_key_id

字符串

如果启用了静态加密，则标识要使用的加密密钥。

该值应为 KMS 密钥 ARN。它也可以是 KMS 密钥 ID。

返回: 成功

endpoint

字符串

用于提交索引和搜索请求的域端点。

返回: 总是

endpoints

字典

包含用于提交索引和搜索请求的域端点的映射。

创建附加到 VPC 域的域时，此属性包含向其提交服务请求的 DNS 端点。

如果在创建 OpenSearch 集群后立即查询 opensearch_info，则可能不会返回 VPC 端点。可能需要几分钟才能使用该端点。

返回: 成功

engine_version

字符串

OpenSearch 域的版本。

返回: 总是

示例: "OpenSearch_1.1"

node_to_node_encryption_options

复杂类型

节点到节点加密选项。

返回: 成功

enabled

布尔值

启用节点到节点加密时为 True。

返回: 成功

processing

布尔值

域配置的状态。如果 Amazon OpenSearch Service 正在处理配置更改，则为 True。如果配置处于活动状态，则为 False。

返回: 总是

snapshot_options

复杂类型

用于设置每日自动快照的时间（UTC 格式）的选项。

返回: 成功

automated_snapshot_start_hour

整数

从 0 到 23 的整数值，指定服务何时对指定的 Elasticsearch 域进行每日自动快照。

返回: 成功

upgrade_processing

布尔值

如果域升级操作正在进行中，则为 true。

返回: 总是

vpc_options

复杂类型

用于指定 VPC 端点的子网和安全组的选项。

返回: 成功

availability_zones

列表 / 元素=字符串

该域的可用区。

返回: 成功

security_group_ids

列表 / 元素=字符串

指定 VPC 端点的安全组 ID。

返回: 成功

subnet_ids

列表 / 元素=字符串

指定 VPC 端点的子网 ID。

返回: 成功

vpc_id

字符串

该域的 VPC ID。

返回: 成功

Authors

  • Sebastien Rosset (@sebastien-rosset)