Модуль community.aws.opensearch_info – получение информации об одном или нескольких доменных зонах OpenSearch или ElasticSearch

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

См. документацию 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 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Расположение файла сертификатов CA для проверки SSL-сертификатов.

Также может быть использована переменная среды 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

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_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним 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, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

tags

словарь

Словарь тегов, используемых для фильтрации доменов OpenSearch, которые соответствуют всем парам ключ-значение тегов.

validate_certs

boolean

При установке в false, сертификаты SSL для связи с AWS API не будут проверены.

Настройка validate_certs=false категорически не рекомендуется; в качестве альтернативы, рассмотрите настройку aws_ca_bundle.

Варианты:

• false
• true ← (по умолчанию)

instances

complex

Список экземпляров домена OpenSearch

Возвращается: всегда

domain_config

complex

Конфигурация домена OpenSearch

Возвращается: всегда

domain_name

string

Имя домена OpenSearch.

Возвращается: всегда

domain_status

complex

Текущий статус домена OpenSearch.

Возвращается: всегда

access_policies

complex

Политика доступа IAM в формате JSON.

Возвращается: успех

advanced_security_options

complex

Указывает дополнительные параметры безопасности.

Возвращается: успех

enabled

boolean

True, если расширенные параметры безопасности включены.

Для использования расширенных параметров безопасности необходимо включить шифрование между узлами.

Возвращается: успех

internal_user_database_enabled

boolean

True, если включена внутренняя база данных пользователей.

Возвращается: успех

master_user_options

complex

Учётные данные для пользователя master: имя пользователя и пароль, ARN или оба.

Возвращается: успех

master_user_arn

string

ARN для пользователя master (если включён IAM).

Возвращается: успех

master_user_name

string

Имя пользователя master, хранящееся во внутренней базе данных домена Amazon OpenSearch Service.

Возвращается: успех

master_user_password

string

Пароль пользователя master, хранящийся во внутренней базе данных домена Amazon OpenSearch Service.

Возвращается: успех

saml_options

complex

Конфигурация приложения SAML для домена.

Возвращается: успех

enabled

boolean

True, если SAML включён.

Возвращается: успех

idp

complex

Информация поставщика удостоверений SAML.

Возвращается: успех

entity_id

string

Уникальный идентификатор сущности приложения в поставщике удостоверений SAML.

Возвращается: успех

metadata_content

string

Метаданные приложения SAML в формате XML.

Возвращается: успех

master_backend_role

string

Задняя роль, на которую сопоставлен главный пользователь SAML.

Возвращается: успех

master_user_name

string

Имя главного пользователя SAML, хранящееся во внутренней базе данных домена Amazon OpenSearch Service.

Возвращается: успех

roles_key

string

Элемент утверждения SAML, используемый для задних ролей. По умолчанию — roles.

Возвращается: успех

session_timeout_minutes

integer

Продолжительность, в минутах, по истечении которой сессия пользователя становится неактивной. Допустимые значения находятся в диапазоне от 1 до 1440, а значение по умолчанию равно 60.

Возвращено: success

subject_key

string

Элемент утверждения SAML, используемый для имени пользователя. Значение по умолчанию — NameID.

Возвращено: success

arn

string

ARN домена OpenSearch.

Возвращено: always

auto_tune_options

complex

Указывает параметры Auto-Tune.

Возвращено: success

desired_state

string

Требуемое состояние Auto-Tune. Допустимые значения: ENABLED и DISABLED.

Возвращено: success

maintenance_schedules

list / elements=dictionary

Список графиков технического обслуживания.

Возвращено: success

cron_expression_for_recurrence

string

Выражение cron для периодического графика технического обслуживания.

Возвращено: success

duration

complex

Указывает продолжительность графика технического обслуживания, значение продолжительности и единицу измерения продолжительности.

Возвращено: success

unit

string

Единица измерения продолжительности графика технического обслуживания. Допустимое значение: HOURS.

Возвращено: success

value

integer

Целое число для указания значения продолжительности графика технического обслуживания.

Возвращено: success

start_at

string

Метка времени, в которую начинается график технического обслуживания Auto-Tune.

Возвращено: success

cluster_config

complex

Параметры для конфигурации кластера домена OpenSearch Service.

Возвращено: success

availability_zone_count

integer

Целочисленное значение, указывающее количество зон доступности для домена, когда включена поддержка нескольких зон. Это значение должно быть равно количеству подсетей, если включены конечные точки VPC.

Возвращено: success

cold_storage_options

complex

Указывает конфигурацию ColdStorageOptions для домена.

Возвращено: success

enabled

boolean

True для включения холодного хранилища. Поддерживается в Elasticsearch 7.9 и выше.

Возвращено: success

dedicated_master_count

integer

Общее количество выделенных узлов master, активных и в режиме ожидания, для домена.

Возвращено: success

dedicated_master_enabled

boolean

Логическое значение, указывающее, включен ли выделенный узел master.

Возвращено: success

dedicated_master_type

string

Тип экземпляра для выделенного узла master.

Возвращено: success

instance_count

integer

Количество экземпляров для домена.

Возвращено: success

instance_type

string

Тип экземпляров, используемых для домена.

Возвращается: success

warm_count

integer

Количество узлов UltraWarm в домене.

Возвращается: success

warm_enabled

boolean

True для включения хранилища UltraWarm.

Возвращается: success

warm_type

string

Тип экземпляра для тёплых узлов домена OpenSearch.

Возвращается: success

zone_awareness

boolean

Логическое значение, указывающее, включена ли поддержка зон.

Возвращается: success

zone_awareness_config

complex

Конфигурация поддержки зон для домена, когда она включена.

Возвращается: success

availability_zone_count

integer

Целочисленное значение, указывающее количество зон доступности для домена, когда поддержка зон включена.

Возвращается: success

zone_awareness_enabled

boolean

Логическое значение, указывающее, включена ли поддержка зон.

Возвращается: success

cognito_options

complex

Параметры для настройки OpenSearch Service для использования аутентификации Amazon Cognito для OpenSearch Dashboards.

Возвращается: success

enabled

boolean

Параметр для включения Cognito для аутентификации OpenSearch Dashboards.

Возвращается: success

identity_pool_id

string

ID пула удостоверений Cognito для аутентификации OpenSearch Dashboards.

Возвращается: success

role_arn

string

ARN роли, которая предоставляет OpenSearch разрешения на доступ к ресурсам Cognito.

Возвращается: success

user_pool_id

string

ID пула пользователей Cognito для аутентификации OpenSearch Dashboards.

Возвращается: success

created

boolean

Статус создания домена. True, если создание домена завершено. False, если создание домена всё ещё в процессе.

Возвращается: всегда

deleted

boolean

Статус удаления домена. True, если запрос на удаление был получен для домена, но очистка ресурсов всё ещё в процессе. False, если домен не был удалён. После завершения удаления домена его статус больше не возвращается.

Возвращается: всегда

domain_endpoint_options

complex

Параметры для указания конфигурации, которая будет применена к конечной точке домена.

Возвращается: success

custom_endpoint

string

Полностью определённое доменное имя для вашей пользовательской конечной точки.

Возвращается: success

custom_endpoint_certificate_arn

string

ARN сертификата ACM для вашей пользовательской конечной точки.

Возвращается: success

custom_endpoint_enabled

boolean

Включать ли пользовательскую конечную точку для домена.

Возвращается: success

enforce_https

boolean

Следует ли разрешать для домена только HTTPS-конечную точку.

Возвращается: success

tls_security_policy

string

Укажите политику безопасности TLS, которую необходимо применить к HTTPS-конечной точке домена.

Возвращается: success

domain_id

string

Уникальный идентификатор домена OpenSearch.

Возвращается: всегда

domain_name

string

Имя домена OpenSearch.

Возвращается: всегда

ebs_options

complex

Параметры для настройки хранилища на основе EBS для домена службы OpenSearch.

Возвращается: success

ebs_enabled

boolean

Указывает, включено ли хранилище на основе EBS.

Возвращается: success

iops

integer

IOPD для тома EBS с заданным количеством операций ввода-вывода (SSD).

Возвращается: success

volume_size

integer

Целое число, указывающее размер тома EBS.

Возвращается: success

volume_type

string

Указывает тип тома для хранилища на основе EBS. “standard”|”gp2”|”io1”

Возвращается: success

encryption_at_rest_options

complex

Параметры для включения шифрования данных в состоянии покоя.

Возвращается: success

enabled

boolean

Следует ли шифровать данные в состоянии покоя.

Возвращается: success

kms_key_id

string

Если включено шифрование данных в состоянии покоя, это идентифицирует используемый ключ шифрования.

Значение должно быть ARN ключа KMS. Это также может быть идентификатор ключа KMS.

Возвращается: success

endpoint

string

Конечная точка домена, которую вы используете для отправки запросов на индексацию и поиск.

Возвращается: всегда

endpoints

dictionary

Карта, содержащая конечные точки домена, используемые для отправки запросов на индексацию и поиск.

Когда вы создаете домен, присоединенный к домену VPC, это свойство содержит DNS-конечную точку, в которую отправляются запросы службы.

Если вы запрашиваете opensearch_info сразу после создания кластера OpenSearch, конечная точка VPC может не возвращаться. Может потребоваться несколько минут, прежде чем конечная точка станет доступна.

Возвращается: success

engine_version

string

Версия домена OpenSearch.

Возвращается: всегда

Пример: "OpenSearch_1.1"

node_to_node_encryption_options

complex

Параметры шифрования узла-узел.

Возвращается: success

enabled

boolean

True для включения шифрования узел-узел.

Возвращается: success

processing

boolean

Статус конфигурации домена. True, если Amazon OpenSearch Service обрабатывает изменения конфигурации. False, если конфигурация активна.

Возвращается: всегда

snapshot_options

complex

Параметр для установки времени в формате UTC ежедневного автоматического снимка.

Возвращается: success

automated_snapshot_start_hour

целое число

Целое значение от 0 до 23, указывающее, в какое время служба выполняет ежедневный автоматический снимок указанного домена Elasticsearch.

Возвращается: успешно

upgrade_processing

логическое

true, если в настоящее время выполняется операция обновления домена.

Возвращается: всегда

vpc_options

сложное

Параметры для указания подсетей и групп безопасности для конечной точки VPC.

Возвращается: успешно

availability_zones

список / элементы=строка

Зоны доступности для домена.

Возвращается: успешно

security_group_ids

список / элементы=строка

Указывает идентификаторы групп безопасности для конечной точки VPC.

Возвращается: успешно

subnet_ids

список / элементы=строка

Указывает идентификаторы подсетей для конечной точки VPC.

Возвращается: успешно

vpc_id

строка

Идентификатор VPC для домена.

Возвращается: успешно