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

access_key

псевдонимы: aws_access_key_id, aws_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 (в порядке убывания приоритета).

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия SDK AWS botocore.

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 для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных в плейбуке.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

domain_name

строка

Имя домена Amazon OpenSearch/ElasticSearch Service.

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

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 и session_token.

region

псевдонимы: aws_region

строка

Регион AWS, который следует использовать.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_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 (в порядке убывания приоритета).

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия SDK AWS botocore.

session_token

псевдонимы: aws_session_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.

Параметры session_token и profile являются взаимоисключающими.

tags

словарь

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

validate_certs

логическое значение

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

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

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

instances

complex

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

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

domain_config

complex

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

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

domain_name

string

Имя домена OpenSearch.

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

domain_status

complex

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

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

access_policies

complex

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

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

advanced_security_options

complex

Задает параметры расширенной безопасности.

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

enabled

boolean

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

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

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

internal_user_database_enabled

boolean

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

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

master_user_options

complex

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

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

master_user_arn

string

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

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

master_user_name

string

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

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

master_user_password

string

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

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

saml_options

complex

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

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

enabled

boolean

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

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

idp

complex

Сведения о поставщике удостоверений SAML.

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

entity_id

string

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

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

metadata_content

string

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

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

master_backend_role

string

Роль серверной части, которой назначен главный пользователь SAML.

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

master_user_name

string

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

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

roles_key

string

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

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

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

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

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

dedicated_master_enabled

boolean

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

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

dedicated_master_type

string

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

Возвращается: 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

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

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

role_arn

string

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

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

user_pool_id

string

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

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

created

boolean

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

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

deleted

boolean

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

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

domain_endpoint_options

complex

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

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

custom_endpoint

string

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

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

custom_endpoint_certificate_arn

string

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

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

custom_endpoint_enabled

boolean

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

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

enforce_https

boolean

Включена ли для домена только конечная точка HTTPS.

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

tls_security_policy

string

Указывает политику безопасности TLS для конечной точки HTTPS домена.

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

domain_id

string

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

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

domain_name

string

Имя домена OpenSearch.

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

ebs_options

complex

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

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

ebs_enabled

boolean

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

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

iops

integer

Значение IOPD для тома EBS (SSD) с подготовленными IOPS.

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

volume_size

integer

Целое число, задающее размер тома EBS.

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

volume_type

string

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

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

encryption_at_rest_options

complex

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

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

enabled

boolean

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

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

kms_key_id

string

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

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

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

endpoint

string

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

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

endpoints

dictionary

Словарь, содержащий конечные точки домена для отправки запросов на индексирование и поиск.

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

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

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

engine_version

string

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

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

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

node_to_node_encryption_options

complex

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

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

enabled

boolean

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

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

processing

boolean

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

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

snapshot_options

complex

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

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

automated_snapshot_start_hour

integer

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

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

upgrade_processing

boolean

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

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

vpc_options

complex

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

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

availability_zones

list / elements=string

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

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

security_group_ids

list / elements=string

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

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

subnet_ids

list / elements=string

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

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

vpc_id

string

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

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