community.aws.opensearch модуль — Создаёт домен OpenSearch или ElasticSearch

access_key

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

строка

ID ключа доступа 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.

access_policies

словарь

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

advanced_security_options

словарь

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

enabled

логический тип

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

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

Варианты:

• false
• true

internal_user_database_enabled

логический тип

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

Варианты:

• false
• true

master_user_options

словарь

Данные для пользователя master (имя пользователя, пароль, ARN или оба).

master_user_arn

строка

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

master_user_name

строка

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

master_user_password

строка

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

saml_options

словарь

Настройка приложения SAML для домена.

enabled

логический тип

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

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

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

Домены поддерживают только один метод аутентификации Dashboards за раз. Если у вас включена аутентификация Amazon Cognito для OpenSearch Dashboards, её нужно отключить, прежде чем включить SAML.

Варианты:

• false
• true

idp

словарь

Информация об IdP SAML.

entity_id

строка

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

metadata_content

строка

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

master_backend_role

строка

Роль бэкэнда, к которой сопоставлен мастер-пользователь SAML.

master_user_name

строка

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

roles_key

строка

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

session_timeout_minutes

целое число

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

subject_key

строка

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

allow_intermediate_upgrades

boolean

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

Если значение false, не разрешить обновление домена OpenSearch через промежуточные версии. Операция обновления завершится ошибкой, если невозможно обновить до engine_version напрямую.

Варианты:

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

auto_tune_options

dictionary

Указывает параметры автоматической настройки.

desired_state

string

Желаемое состояние автоматической настройки. Допустимые значения: ENABLED и DISABLED.

Варианты:

• "ENABLED"
• "DISABLED"

maintenance_schedules

list / elements=dictionary

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

cron_expression_for_recurrence

string

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

duration

dictionary

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

unit

string

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

Варианты:

• "HOURS"

value

integer

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

start_at

string

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

aws_ca_bundle

path

Расположение файла сертификата CA, используемого для проверки SSL-сертификатов.

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

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

cluster_config

dictionary

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

availability_zone_count

integer

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

cold_storage_options

dictionary

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

enabled

boolean

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

Варианты:

• false
• true

dedicated_master

boolean

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

Варианты:

• false
• true

dedicated_master_instance_count

integer

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

dedicated_master_instance_type

string

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

instance_count

integer

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

instance_type

string

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

warm_count

integer

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

warm_enabled

boolean

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

Варианты:

• false
• true

warm_type

string

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

zone_awareness

boolean

Логическое значение, указывающее, включена ли функция учета зон.

Варианты:

• false
• true

cognito_options

dictionary

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

enabled

boolean

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

Варианты:

• false
• true

identity_pool_id

string

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

role_arn

string

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

user_pool_id

string

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

debug_botocore_endpoint_logs

boolean

Используйте botocore.endpoint логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, выполненный во время выполнения книги сценариев.

Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.

Варианты:

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

domain_endpoint_options

dictionary

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

custom_endpoint

string

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

custom_endpoint_certificate_arn

string

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

custom_endpoint_enabled

boolean

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

Варианты:

• false
• true

enforce_https

boolean

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

Варианты:

• false
• true

tls_security_policy

string

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

domain_name

string / обязательно

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

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

ebs_options

dictionary

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

ebs_enabled

boolean

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

Варианты:

• false
• true

iops

integer

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

volume_size

integer

Целое число для указания размера тома EBS.

volume_type

string

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

encryption_at_rest_options

dictionary

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

enabled

boolean

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

Варианты:

• false
• true

kms_key_id

string

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

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

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

string

-> Версия движка для использования. Например, ‘ElasticSearch_7.10’ или ‘OpenSearch_1.1’. -> Если текущая версия не равна engine_version, запускается обновление кластера. -> Возможно, прямое обновление с текущей версии на engine_version невозможно. В этом случае обновление выполняется постепенно, до тех пор пока кластер не будет работать с целевой версией. -> Операция обновления завершается неудачно, если нет пути от текущей версии к engine_version. -> Смотрите документацию OpenSearch по совместимости обновлений.

node_to_node_encryption_options

dictionary

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

enabled

boolean

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

Варианты:

• false
• true

profile

aliases: aws_profile

string

Используемый профиль 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

boolean

Если 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

aliases: aws_region, ec2_region

string

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

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа 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

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сеанса 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.

snapshot_options

dictionary

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

automated_snapshot_start_hour

integer

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

состояние

строка

Создаёт или изменяет существующий домен OpenSearch.

Удаляет домен OpenSearch.

Варианты:

• "present" ← (по умолчанию)
• "absent"

метки

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

словарь

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

Если параметр метки не задан, метки не будут изменены.

validate_certs

логическое

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

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

Варианты:

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

vpc_options

словарь

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

security_groups

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

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

subnets

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

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

wait

логическое

Дожидаться завершения создания, изменения или удаления OpenSearch.

Варианты:

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

wait_timeout

целое число

Сколько времени ждать, прежде чем прервать ожидание, в секундах.

По умолчанию: 300