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 服务域的信息。

需求 

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

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`
domain_name 字符串	Amazon OpenSearch/Elasticsearch 服务域的名称。
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	连接到默认 AWS 端点以外的 URL。虽然这可用于连接到其他与 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选项互斥。在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之后的一个版本中移除。
tags 字典	用于筛选与所有标签键值对匹配的OpenSearch域的标签字典。
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: 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

返回值 

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

键	描述
instances 复杂类型	OpenSearch域实例列表返回值：始终返回
domain_config 复杂类型	OpenSearch域配置返回值：始终返回
domain_name 字符串	OpenSearch域的名称。返回值：始终返回
domain_status 复杂类型	OpenSearch域的当前状态。返回值：始终返回
access_policies 复杂类型	以JSON格式字符串表示的IAM访问策略。返回值：成功时返回
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 复杂类型	指定自动调整选项。返回值：成功时返回
desired_state 字符串	自动调整所需状态。有效值为ENABLED和DISABLED。返回值：成功时返回
maintenance_schedules 列表 / 元素=字典	维护计划列表。返回值：成功时返回
cron_expression_for_recurrence 字符串	重复维护计划的cron表达式。返回值：成功时返回
duration 复杂类型	指定维护计划持续时间、持续时间值和持续时间单位。返回值：成功时返回
unit 字符串	维护计划持续时间的单位。有效值为HOURS。返回值：成功时返回
value 整数	指定维护计划持续时间值的整数。返回值：成功时返回
start_at 字符串	自动调整维护计划开始的时间戳。返回值：成功时返回
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 布尔值	用于启用Cognito进行OpenSearch Dashboards身份验证的选项。返回值：成功时返回
identity_pool_id 字符串	OpenSearch Dashboards身份验证的Cognito身份池ID。返回值：成功时返回
role_arn 字符串	提供OpenSearch访问Cognito资源权限的角色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 复杂类型	配置基于 EBS 的 OpenSearch 服务域存储的参数。返回值：成功时返回
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 服务正在处理配置更改，则为 True；如果配置处于活动状态，则为 False。返回值：始终返回
snapshot_options 复杂类型	用于设置每日自动快照的 UTC 时间的选项。返回值：成功时返回
automated_snapshot_start_hour 整数	指定服务何时对指定的 Elasticsearch 域进行每日自动快照的 0 到 23 之间的整数值。返回值：成功时返回
upgrade_processing 布尔值	如果域升级操作正在进行中，则为 true。返回值：始终返回
vpc_options 复杂类型	指定 VPC 端点的子网和安全组的选项。返回值：成功时返回
availability_zones 列表 / 元素=字符串	域的可用区。返回值：成功时返回
security_group_ids 列表 / 元素=字符串	指定 VPC 端点的安全组 ID。返回值：成功时返回
subnet_ids 列表 / 元素=字符串	指定 VPC 端点的子网 ID。返回值：成功时返回
vpc_id 字符串	域的 VPC ID。返回值：成功时返回

作者

Sebastien Rosset (@sebastien-rosset)