community.aws.opensearch 模块 – 创建 OpenSearch 或 ElasticSearch 域

注意

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

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

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

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

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 botocore SDK 保持一致，在版本 5.1.0 中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
access_policies 字典	IAM 访问策略，为 JSON 格式的字符串。
advanced_security_options 字典	指定高级安全选项。
enabled 布尔值	如果启用了高级安全性，则为 True。 您必须启用节点到节点加密才能使用高级安全选项。 选择 false true
internal_user_database_enabled 布尔值	如果启用了内部用户数据库，则为 True。 选择 false 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。 要使用 SAML 身份验证，您必须启用精细访问控制。 您只能为现有域上的 OpenSearch Dashboards 启用 SAML 身份验证，而不能在创建新域时启用。 域一次仅支持一种 Dashboards 身份验证方法。 如果您启用了针对 OpenSearch Dashboards 的 Amazon Cognito 身份验证，则必须先将其禁用，然后才能启用 SAML。 选择 false 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 断言元素。 默认值为角色。
session_timeout_minutes 整数	用户会话变为非活动状态的持续时间（以分钟为单位）。 可接受的值介于 1 到 1440 之间，默认值为 60。
subject_key 字符串	用于用户名的 SAML 断言元素。 默认值为 NameID。
allow_intermediate_upgrades 布尔值	如果为 true，则允许 OpenSearch 域通过一个或多个中间版本进行升级。 如果为 false，则不允许 OpenSearch 域通过中间版本进行升级。 如果无法直接升级到 engine_version，则升级操作失败。 选择 false true ← (默认)
auto_tune_options 字典	指定 Auto-Tune 选项。
desired_state 字符串	Auto-Tune 的所需状态。 有效值为 ENABLED 和 DISABLED。 选择 "ENABLED" "DISABLED"
maintenance_schedules 列表 / 元素=字典	维护计划列表。
cron_expression_for_recurrence 字符串	定期维护计划的 cron 表达式。
duration 字典	指定维护计划的持续时间、持续时间值和持续时间单位。
unit 字符串	维护计划持续时间的单位。 有效值为 HOURS。 选择 "HOURS"
value 整数	指定维护计划持续时间值的整数。
start_at 字符串	Auto-Tune 维护计划开始的时间戳。
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。
cluster_config 字典	OpenSearch Service 域的集群配置参数。
availability_zone_count 整数	一个整数值，表示启用可用区感知时域的可用区数量。如果启用了 VPC 终端节点，则此值应等于子网数量。
cold_storage_options 字典	指定域的 ColdStorageOptions 配置。
enabled 布尔值	设置为 True 以启用冷存储。支持 Elasticsearch 7.9 或更高版本。 选择 false true
dedicated_master 布尔值	一个布尔值，表示是否启用了专用主节点。 选择 false true
dedicated_master_instance_count 整数	域的专用主节点总数，包括活动节点和备用节点。
dedicated_master_instance_type 字符串	专用主节点的实例类型。
instance_count 整数	域的实例数量。
instance_type 字符串	用于域的实例类型。
warm_count 整数	域中 UltraWarm 节点的数量。
warm_enabled 布尔值	设置为 True 以启用 UltraWarm 存储。 选择 false true
warm_type 字符串	OpenSearch 域的温节点的实例类型。
zone_awareness 布尔值	一个布尔值，表示是否启用了可用区感知。 选择 false true
cognito_options 字典	配置 OpenSearch Service 使用 Amazon Cognito 身份验证进行 OpenSearch Dashboards 身份验证的参数。
enabled 布尔值	为 OpenSearch Dashboards 身份验证启用 Cognito 的选项。 选择 false true
identity_pool_id 字符串	用于 OpenSearch Dashboards 身份验证的 Cognito 身份池 ID。
role_arn 字符串	为访问 Cognito 资源的 OpenSearch 提供权限的角色 ARN。
user_pool_id 字符串	用于 OpenSearch Dashboards 身份验证的 Cognito 用户池 ID。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间发出的唯一（而不是总计）"resource:action" API 调用，并将结果集输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出到 playbook 期间发出的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选择 false ← （默认） true
domain_endpoint_options 字典	指定将应用于域端点的配置的选项。
custom_endpoint 字符串	自定义端点的完全限定域名。
custom_endpoint_certificate_arn 字符串	自定义端点的 ACM 证书 ARN。
custom_endpoint_enabled 布尔值	是否为域启用自定义端点。 选择 false true
enforce_https 布尔值	是否只应为域启用 HTTPS 端点。 选择 false true
tls_security_policy 字符串	指定应用于域的 HTTPS 端点的 TLS 安全策略。
domain_name 字符串 / 必填	Amazon OpenSearch/ElasticSearch 服务域的名称。 域名在 AWS 区域内由帐户拥有的域中是唯一的。
ebs_options 字典	配置 OpenSearch Service 域的基于 EBS 的存储的参数。
ebs_enabled 布尔值	指定是否启用基于 EBS 的存储。 选择 false true
iops 整数	预配置 IOPS EBS 卷 (SSD) 的 IOPS。
volume_size 整数	指定 EBS 卷大小的整数。
volume_type 字符串	指定基于 EBS 的存储的卷类型。“标准”|“gp2”|“io1”
encryption_at_rest_options 字典	启用静态加密的参数。
enabled 布尔值	是否应在静态时对数据进行加密。 选择 false true
kms_key_id 字符串	如果启用了静态加密，则此项标识要使用的加密密钥。 该值应为 KMS 密钥 ARN。它也可以是 KMS 密钥 ID。
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 之后的版本中删除。
engine_version 字符串	-> 要使用的引擎版本。例如，'ElasticSearch_7.10' 或 'OpenSearch_1.1'。 -> 如果当前运行的版本与 engine_version 不相同，则会触发集群升级。 -> 可能无法直接从当前运行的版本升级到 engine_version。在这种情况下，升级是通过升级到最高的兼容版本来逐步执行的，然后重复该操作，直到集群以目标版本运行。 -> 如果没有从当前版本到 engine_version 的路径，则升级操作将失败。 -> 有关升级兼容性，请参阅 OpenSearch 文档。
node_to_node_encryption_options 字典	节点到节点加密选项。
enabled 布尔值	设置为 True 以启用节点到节点加密。 选择 false true
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 布尔值	如果 purge_tags=true 并且设置了 tags，则会从资源中清除现有标签，以完全匹配 tags 参数定义的标签。 如果未设置 tags 参数，则即使 purge_tags=True，也不会修改标签。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，出于 purge_tags 参数的目的，它们将被忽略。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选择 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 之后的版本中删除。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS secret access key。 有关访问令牌的更多信息，请参阅 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 之后的版本中删除。
snapshot_options 字典	设置每日自动快照时间的选项，采用 UTC 格式。
automated_snapshot_start_hour 整数	一个从 0 到 23 的整数值，指定服务何时对指定的 Elasticsearch 域进行每日自动快照。
state 字符串	创建或修改现有的 OpenSearch 域。 删除 OpenSearch 域。 选择 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	一个字典，表示要应用于资源的标签。 如果未设置 tags 参数，则不会修改标签。
validate_certs 布尔值	当设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选择 false true ← (默认)
vpc_options 字典	指定 VPC 端点的子网和安全组的选项。
security_groups 列表 / 元素=字符串	指定 VPC 端点的安全组 ID。
subnets 列表 / 元素=字符串	指定 VPC 端点的子网 ID。
wait 布尔值	是否等待 OpenSearch 创建、修改或删除完成。 选择 false ← （默认） true
wait_timeout 整数	等待放弃前的时间，以秒为单位。 默认值： 300

注意

注意

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

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

示例

- name: Create OpenSearch domain for dev environment, no zone awareness, no dedicated masters
  community.aws.opensearch:
    domain_name: "dev-cluster"
    engine_version: Elasticsearch_1.1
    cluster_config:
      instance_type: "t2.small.search"
      instance_count: 2
      zone_awareness: false
      dedicated_master: false
    ebs_options:
      ebs_enabled: true
      volume_type: "gp2"
      volume_size: 10
    access_policies: "{{ lookup('file', 'policy.json') | from_json }}"

- name: Create OpenSearch domain with dedicated masters
  community.aws.opensearch:
    domain_name: "my-domain"
    engine_version: OpenSearch_1.1
    cluster_config:
      instance_type: "t2.small.search"
      instance_count: 12
      dedicated_master: true
      zone_awareness: true
      availability_zone_count: 2
      dedicated_master_instance_type: "t2.small.search"
      dedicated_master_instance_count: 3
      warm_enabled: true
      warm_type: "ultrawarm1.medium.search"
      warm_count: 1
      cold_storage_options:
        enabled: false
    ebs_options:
      ebs_enabled: true
      volume_type: "io1"
      volume_size: 10
      iops: 1000
    vpc_options:
      subnets:
        - "subnet-e537d64a"
        - "subnet-e537d64b"
      security_groups:
        - "sg-dd2f13cb"
        - "sg-dd2f13cc"
    snapshot_options:
      automated_snapshot_start_hour: 13
    access_policies: "{{ lookup('file', 'policy.json') | from_json }}"
    encryption_at_rest_options:
      enabled: false
    node_to_node_encryption_options:
      enabled: false
    auto_tune_options:
      enabled: true
      maintenance_schedules:
        - start_at: "2025-01-12"
          duration:
            value: 1
            unit: "HOURS"
          cron_expression_for_recurrence: "cron(0 12 * * ? *)"
        - start_at: "2032-01-12"
          duration:
            value: 2
            unit: "HOURS"
          cron_expression_for_recurrence: "cron(0 12 * * ? *)"
    tags:
      Environment: Development
      Application: Search
    wait: true

- name: Increase size of EBS volumes for existing cluster
  community.aws.opensearch:
    domain_name: "my-domain"
    ebs_options:
      volume_size: 5
    wait: true

- name: Increase instance count for existing cluster
  community.aws.opensearch:
    domain_name: "my-domain"
    cluster_config:
      instance_count: 40
    wait: true

作者

• Sebastien Rosset (@sebastien-rosset)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通