create-domain

Описание

Создаёт домен Amazon OpenSearch Service. Дополнительную информацию см. в разделе Создание и управление доменами Amazon OpenSearch Service.

См. также: Документация API AWS

Синтаксис

  create-domain
--domain-name <value>
[--engine-version <value>]
[--cluster-config <value>]
[--ebs-options <value>]
[--access-policies <value>]
[--ip-address-type <value>]
[--snapshot-options <value>]
[--vpc-options <value>]
[--cognito-options <value>]
[--encryption-at-rest-options <value>]
[--node-to-node-encryption-options <value>]
[--advanced-options <value>]
[--log-publishing-options <value>]
[--domain-endpoint-options <value>]
[--advanced-security-options <value>]
[--identity-center-options <value>]
[--tag-list <value>]
[--auto-tune-options <value>]
[--off-peak-window-options <value>]
[--software-update-options <value>]
[--aiml-options <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--domain-name (строка)

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

--engine-version (строка)

Строка в формате Elasticsearch_X.Y или OpenSearch_X.Y, указывающая версию движка для домена OpenSearch Service. Например, OpenSearch_1.0 или Elasticsearch_7.9 . Дополнительную информацию см. в разделе Создание и управление доменами Amazon OpenSearch Service.

--cluster-config (структура)

Контейнер для конфигурации кластера домена.

InstanceType -> (строка)

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

InstanceCount -> (целое число)

Количество узлов данных в кластере. Это число должно быть больше 1, в противном случае будет выдано исключение валидации.

DedicatedMasterEnabled -> (булево)

Указывает, включены ли выделенные мастер-узлы для кластера.``True``, если кластер использует выделенный мастер-узел.``False``, если кластер не использует выделенный мастер-узел.

ZoneAwarenessEnabled -> (булево)

Указывает, включены ли несколько доступных зон. Дополнительную информацию см. в разделе Настройка домена с несколькими зонами доступности в Amazon OpenSearch Service.

ZoneAwarenessConfig -> (структура)

Контейнер для параметров конфигурации зоны доступности. Требуется только если ZoneAwarenessEnabled равно true.

AvailabilityZoneCount -> (целое число)

Если включены несколько доступных зон, это значение представляет количество зон, которые вы хотите использовать для домена. Допустимые значения — 2 и 3 . Если ваш домен развернут в VPC, это значение должно быть равно количеству подсетей.

DedicatedMasterType -> (строка)

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

DedicatedMasterCount -> (целое число)

Количество выделенных мастер-узлов в кластере. Это число должно быть больше 2 и не равно 4, в противном случае будет выдано исключение валидации.

WarmEnabled -> (булево)

Включает ли тёплый (warm) хранилище для кластера.

WarmType -> (строка)

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

WarmCount -> (целое число)

Количество тёплых узлов в кластере.

ColdStorageOptions -> (структура)

Контейнер для параметров конфигурации холодного хранилища.

Enabled -> (булево)

Включает или отключает холодное хранилище в домене. Для включения холодного хранилища необходимо включить UltraWarm хранилище.

MultiAZWithStandbyEnabled -> (булево)

Булево значение, указывающее, включён ли домен с несколькими зонами доступности со резервной зоной. Дополнительную информацию см. в разделе Настройка домена с несколькими зонами доступности в Amazon OpenSearch Service.

NodeOptions -> (список)

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

(структура)

Настройки конфигурации для определения типа узла в кластере.

NodeType -> (строка)

Определяет тип узла, например, координирующие узлы.

NodeConfig -> (структура)

Настройки конфигурации для определения настроек любого типа узла.

Enabled -> (булево)

Булевое значение, указывающее, активен или неактивен определённый тип узла.

Type -> (строка)

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

Count -> (целое число)

Количество узлов определённого типа в кластере.

Синтаксис JSON:

{
  "InstanceType": "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
  "InstanceCount": integer,
  "DedicatedMasterEnabled": true|false,
  "ZoneAwarenessEnabled": true|false,
  "ZoneAwarenessConfig": {
    "AvailabilityZoneCount": integer
  },
  "DedicatedMasterType": "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
  "DedicatedMasterCount": integer,
  "WarmEnabled": true|false,
  "WarmType": "ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search",
  "WarmCount": integer,
  "ColdStorageOptions": {
    "Enabled": true|false
  },
  "MultiAZWithStandbyEnabled": true|false,
  "NodeOptions": [
    {
      "NodeType": "coordinator",
      "NodeConfig": {
        "Enabled": true|false,
        "Type": "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
        "Count": integer
      }
    }
    ...
  ]
}

--ebs-options (структура)

Контейнер для параметров, необходимых для включения хранения на основе EBS для домена OpenSearch Service.

EBSEnabled -> (булево)

Указывает, подключены ли тома EBS к узлам данных в домене OpenSearch Service.

VolumeType -> (строка)

Указывает тип томов EBS, подключённых к узлам данных.

VolumeSize -> (целое число)

Указывает размер (в ГБ) томов EBS, подключённых к узлам данных.

Iops -> (целое число)

Указывает базовые показатели ввода/вывода (I/O) томов EBS, подключённых к узлам данных. Применимо только для типов томов EBS gp3 и provisioned IOPS.

Throughput -> (целое число)

Указывает пропускную способность (в МБ/с) томов EBS, подключённых к узлам данных. Применимо только для типа тома gp3.

Краткая запись:

EBSEnabled=boolean,VolumeType=string,VolumeSize=integer,Iops=integer,Throughput=integer

Синтаксис JSON:

{
  "EBSEnabled": true|false,
  "VolumeType": "standard"|"gp2"|"io1"|"gp3",
  "VolumeSize": integer,
  "Iops": integer,
  "Throughput": integer
}

--access-policies (строка)

Документ политики Identity and Access Management (IAM), определяющий политики доступа для нового домена.

--ip-address-type (строка)

Укажите двойной стек или IPv4 в качестве типа вашего IP-адреса. Двойной стек позволяет вам совместно использовать ресурсы домена между типами адресов IPv4 и IPv6, и является рекомендуемым вариантом. Если вы зададите тип IP-адреса как двойной стек, вы не сможете изменить тип адреса позже.

Возможные значения:

ipv4
dualstack

--snapshot-options (структура)

УСТЕРЕЛО. Контейнер для параметров, необходимых для настройки автоматических снимков индексов домена.

AutomatedSnapshotStartHour -> (целое число)

Время в формате UTC, когда OpenSearch Service делает ежедневный автоматический снимок указанного домена. По умолчанию — 0 час.

Краткая запись:

AutomatedSnapshotStartHour=integer

Синтаксис JSON:

{
  "AutomatedSnapshotStartHour": integer
}

--vpc-options (структура)

Контейнер для значений, необходимых для настройки доменов с доступом по VPC. Если вы не укажете эти значения, OpenSearch Service создаст домен с общедоступным конечным пунктом. Дополнительную информацию см. в разделе Запуск ваших доменов Amazon OpenSearch Service с использованием VPC.

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

Краткая запись:

SubnetIds=string,string,SecurityGroupIds=string,string

Синтаксис JSON:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["string", ...]
}

--cognito-options (структура)

Ключевые пары для настройки аутентификации Amazon Cognito. Дополнительную информацию см. в разделе Настройка аутентификации Amazon Cognito для OpenSearch Dashboards.

Enabled -> (булево)

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

UserPoolId -> (строка)

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

IdentityPoolId -> (строка)

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

RoleArn -> (строка)

Роль AmazonOpenSearchServiceCognitoAccess, которая позволяет OpenSearch Service настроить ваш пул пользователей и пул идентификаторов.

Краткая запись:

Enabled=boolean,UserPoolId=string,IdentityPoolId=string,RoleArn=string

Синтаксис JSON:

{
  "Enabled": true|false,
  "UserPoolId": "string",
  "IdentityPoolId": "string",
  "RoleArn": "string"
}

--encryption-at-rest-options (структура)

Ключевые пары для включения шифрования данных на уровне хранения.

Enabled -> (булево)

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

KmsKeyId -> (строка)

Идентификатор ключа KMS. Принимает вид 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

Краткая запись:

Enabled=boolean,KmsKeyId=string

Синтаксис JSON:

{
  "Enabled": true|false,
  "KmsKeyId": "string"
}

--node-to-node-encryption-options (структура)

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

Enabled -> (булево)

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

Краткая запись:

Enabled=boolean

Синтаксис JSON:

{
  "Enabled": true|false
}

--advanced-options (массив)

Ключевые пары для указания расширенных параметров конфигурации. Поддерживаются следующие пары ключ-значение:

"rest.action.multi.allow_explicit_index": "true" | "false" - Обратите внимание на использование строки вместо булевого значения. Указывает, разрешены ли явные ссылки на индексы внутри тела HTTP-запросов. Если вы хотите настроить политики доступа для подресурсов домена, таких как определённые индексы и API домена, вы должны отключить эту свойство. По умолчанию — true.
"indices.fielddata.cache.size": "80" - Обратите внимание на использование строки вместо булевого значения. Указывает процент объёма кучи, выделенной для данных полей. По умолчанию — неограниченно.
"indices.query.bool.max_clause_count": "1024" - Обратите внимание на использование строки вместо булевого значения. Указывает максимальное количество клаузов, разрешённых в запросе Lucene boolean. По умолчанию — 1024. Запросы с большим количеством клаузов, чем разрешено, приводят к ошибке TooManyClauses.
"override_main_response_version": "true" | "false" - Обратите внимание на использование строки вместо булевого значения. Указывает, сообщает ли домен свою версию как 7.10, чтобы позволить клиентам и плагинам Elasticsearch OSS продолжать работу с ним. По умолчанию — false при создании домена и true при обновлении домена.

Дополнительную информацию см. в разделе Расширенные параметры кластера.

key -> (строка)

value -> (строка)

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--log-publishing-options (массив)

Параметры пар «ключ-значение» для настройки публикации логов.

ключ -> (строка)

Тип файла журнала. Может быть одним из следующих:

INDEX_SLOW_LOGS - Журналы медленных операций индексации содержат запросы вставки, которые выполнялись дольше, чем заданный порог для журналов запросов индексации.
SEARCH_SLOW_LOGS - Журналы медленных поисковых запросов содержат поисковые запросы, которые выполнялись дольше, чем заданный порог для журналов запросов поиска.
ES_APPLICATION_LOGS - Журналы приложений OpenSearch содержат информацию об ошибках и предупреждениях, возникших во время работы службы, и могут быть полезны для устранения неполадок.
AUDIT_LOGS - Аудит-журналы содержат записи о пользовательских запросах доступа к домену.

значение -> (структура)

Указывает, публикует ли домен Amazon OpenSearch Service журналы приложений OpenSearch и медленных запросов в Amazon CloudWatch. Дополнительная информация в разделе Мониторинг логов OpenSearch с помощью Amazon CloudWatch Logs.

Примечание

После включения публикации логов необходимо включить сбор медленных логов с помощью API OpenSearch REST.

CloudWatchLogsLogGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы CloudWatch Logs, в которую должны быть опубликованы логи.

Enabled -> (булево)

Должен ли журнал быть опубликован.

Сокращенная запись:

  KeyName1=CloudWatchLogsLogGroupArn=string,Enabled=boolean,KeyName2=CloudWatchLogsLogGroupArn=string,Enabled=boolean

Where valid key names are:
  INDEX_SLOW_LOGS
  SEARCH_SLOW_LOGS
  ES_APPLICATION_LOGS
  AUDIT_LOGS

Формат JSON:

{"INDEX_SLOW_LOGS"|"SEARCH_SLOW_LOGS"|"ES_APPLICATION_LOGS"|"AUDIT_LOGS": {
      "CloudWatchLogsLogGroupArn": "string",
      "Enabled": true|false
    }
  ...}

--domain-endpoint-options (структура)

Дополнительные параметры для конечной точки домена, такие как требование HTTPS для всего трафика.

EnforceHTTPS -> (булево)

Устанавливает требование к тому, чтобы весь трафик домена поступал по протоколу HTTPS.

TLSSecurityPolicy -> (строка)

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

Policy-Min-TLS-1-0-2019-07: Политика безопасности TLS, поддерживающая версии TLS от 1.0 до 1.2.
Policy-Min-TLS-1-2-2019-07: Политика безопасности TLS, поддерживающая только версию TLS 1.2.
Policy-Min-TLS-1-2-PFS-2023-10: Политика безопасности TLS, поддерживающая версии TLS от 1.2 до 1.3 с совершенной прямой секретностью.

CustomEndpointEnabled -> (булево)

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

CustomEndpoint -> (строка)

Полный URL пользовательской конечной точки.

CustomEndpointCertificateArn -> (строка)

ARN сертификата безопасности, управляемого в Amazon Web Services Certificate Manager (ACM).

Сокращенная запись:

EnforceHTTPS=boolean,TLSSecurityPolicy=string,CustomEndpointEnabled=boolean,CustomEndpoint=string,CustomEndpointCertificateArn=string

Формат JSON:

{
  "EnforceHTTPS": true|false,
  "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"|"Policy-Min-TLS-1-2-PFS-2023-10",
  "CustomEndpointEnabled": true|false,
  "CustomEndpoint": "string",
  "CustomEndpointCertificateArn": "string"
}

--advanced-security-options (структура)

Параметры для точного управления доступом.

Enabled -> (булево)

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

InternalUserDatabaseEnabled -> (булево)

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

MasterUserOptions -> (структура)

Контейнер с информацией о главном пользователе.

MasterUserARN -> (строка)

Идентификатор ресурса Amazon (ARN) для главного пользователя. Указывать только если InternalUserDatabaseEnabled равно false.

MasterUserName -> (строка)

Имя пользователя для главного пользователя. Указывать только если InternalUserDatabaseEnabled равно true.

MasterUserPassword -> (строка)

Пароль главного пользователя. Указывать только если InternalUserDatabaseEnabled равно true.

SAMLOptions -> (структура)

Контейнер с информацией о конфигурации SAML для OpenSearch Dashboards.

Enabled -> (булево)

Включить аутентификацию SAML для домена.

Idp -> (структура)

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

MetadataContent -> (строка)

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

EntityId -> (строка)

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

MasterUserName -> (строка)

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

MasterBackendRole -> (строка)

Роль бэкенда, к которой привязан главный пользователь SAML.

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

SessionTimeoutMinutes -> (целое число)

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

JWTOptions -> (структура)

Контейнер с информацией о конфигурации JWT для Amazon OpenSearch Service.

Enabled -> (булево)

Включить аутентификацию и авторизацию JWT для домена.

SubjectKey -> (строка)

Элемент утверждения JWT, используемый для имени пользователя.

RolesKey -> (строка)

Элемент утверждения JWT, используемый для ролей.

PublicKey -> (строка)

Элемент утверждения JWT, используемый кластером для проверки подписей JWT.

AnonymousAuthEnabled -> (булево)

Включить 30-дневный период миграции, в течение которого администраторы могут создавать сопоставления ролей. Необходим только при включении точного управления доступом в существующем домене.

Сокращенная запись:

Enabled=boolean,InternalUserDatabaseEnabled=boolean,MasterUserOptions={MasterUserARN=string,MasterUserName=string,MasterUserPassword=string},SAMLOptions={Enabled=boolean,Idp={MetadataContent=string,EntityId=string},MasterUserName=string,MasterBackendRole=string,SubjectKey=string,RolesKey=string,SessionTimeoutMinutes=integer},JWTOptions={Enabled=boolean,SubjectKey=string,RolesKey=string,PublicKey=string},AnonymousAuthEnabled=boolean

Формат JSON:

{
  "Enabled": true|false,
  "InternalUserDatabaseEnabled": true|false,
  "MasterUserOptions": {
    "MasterUserARN": "string",
    "MasterUserName": "string",
    "MasterUserPassword": "string"
  },
  "SAMLOptions": {
    "Enabled": true|false,
    "Idp": {
      "MetadataContent": "string",
      "EntityId": "string"
    },
    "MasterUserName": "string",
    "MasterBackendRole": "string",
    "SubjectKey": "string",
    "RolesKey": "string",
    "SessionTimeoutMinutes": integer
  },
  "JWTOptions": {
    "Enabled": true|false,
    "SubjectKey": "string",
    "RolesKey": "string",
    "PublicKey": "string"
  },
  "AnonymousAuthEnabled": true|false
}

--identity-center-options (структура)

Параметры конфигурации для включения и управления интеграцией IAM Identity Center в домене.

EnabledAPIAccess -> (булево)

Указывает, включена ли интеграция IAM Identity Center для доступа к API в Amazon OpenSearch Service.

IdentityCenterInstanceARN -> (строка)

ARN экземпляра IAM Identity Center, используемого для создания приложения OpenSearch UI, использующего IAM Identity Center для аутентификации.

SubjectKey -> (строка)

Указывает атрибут, содержащий идентификатор субъекта (такой как имя пользователя, идентификатор пользователя или электронная почта) в IAM Identity Center.

RolesKey -> (строка)

Указывает атрибут, содержащий идентификатор роли бэкенда (например, имя группы или идентификатор группы) в IAM Identity Center.

Сокращенная запись:

EnabledAPIAccess=boolean,IdentityCenterInstanceARN=string,SubjectKey=string,RolesKey=string

Формат JSON:

{
  "EnabledAPIAccess": true|false,
  "IdentityCenterInstanceARN": "string",
  "SubjectKey": "UserName"|"UserId"|"Email",
  "RolesKey": "GroupName"|"GroupId"
}

--tag-list (список)

Список тегов, которые нужно добавить к домену при создании.

(структура)

Тег (пара «ключ-значение») для ресурса Amazon OpenSearch Service.

Key -> (строка)

Ключ тега. Ключи тегов должны быть уникальными для домена, к которому они прикреплены.

Value -> (строка)

Значение, назначенное соответствующему ключу тега. Значения тегов могут быть null и не обязательно должны быть уникальными в наборе тегов. Например, можно иметь пару «ключ-значение» в наборе тегов со значениями project : Trinity и cost-center : Trinity

Сокращенная запись:

Key=string,Value=string ...

Формат JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--auto-tune-options (структура)

Параметры для Auto-Tune.

DesiredState -> (строка)

Включен или выключен Auto-Tune.

MaintenanceSchedules -> (список)

Список расписаний обслуживания, в течение которых Auto-Tune может внедрять изменения. Плановые окна обслуживания устарели и заменены внепиковыми окнами.

(структура)

Примечание

Этот объект устарел. Используйте внепиковое окно домена для планирования оптимизаций Auto-Tune. Инструкции по миграции см. в разделе Миграция с плановых окон обслуживания Auto-Tune.

Расписание обслуживания Auto-Tune. Дополнительная информация в разделе Auto-Tune для Amazon OpenSearch Service.

StartAt -> (метка времени)

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

Duration -> (структура)

Продолжительность расписания обслуживания. Например, "Duration": {"Value": 2, "Unit": "HOURS"}.

Value -> (целое число)

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

Unit -> (строка)

Единица измерения продолжительности расписания обслуживания.

CronExpressionForRecurrence -> (строка)

Выражение CRON для периодического расписания обслуживания, в течение которого Auto-Tune может развернуть изменения.

UseOffPeakWindow -> (булево)

Планировать оптимизации Auto-Tune, которые требуют развертываний по типу «синий/зеленый», в течение заданного внепикового окна домена.

--off-peak-window-options (структура)

Указывает 10-часовой ежедневный временной интервал, в течение которого OpenSearch Service может вносить изменения в конфигурацию домена, включая обновления программного обеспечения службы и улучшения Auto-Tune, требующие развертывания по принципу «синий/зеленый». Если не указаны параметры, используется время начала по умолчанию в 22:00 по местному времени для региона, в котором создан домен.

Enabled -> (булево)

Включить внепиковое окно.

Этот параметр доступен только при изменении домена, созданного до 16 февраля 2023 года, а не при создании нового домена. Для всех доменов, созданных после этой даты, внепиковое окно включено по умолчанию. После включения внепикового окна для домена его нельзя отключить.

OffPeakWindow -> (структура)

Параметры внепикового окна для домена.

WindowStartTime -> (структура)

Пользовательское начальное время для внепикового окна в формате Coordinated Universal Time (UTC). Длительность окна всегда составляет 10 часов, поэтому вы не можете указать конечное время. Например, если вы укажете 23:00 UTC как время начала, время окончания будет автоматически установлено на 9:00 UTC.

Hours -> (целое число)

Начальный час окна в формате Coordinated Universal Time (UTC) в 24-часовом формате. Например, 17 относится к 17:00 UTC.

Minutes -> (целое число)

Начальная минута окна в формате UTC.

Сокращенная запись:

Enabled=boolean,OffPeakWindow={WindowStartTime={Hours=long,Minutes=long}}

Формат JSON:

{
  "Enabled": true|false,
  "OffPeakWindow": {
    "WindowStartTime": {
      "Hours": long,
      "Minutes": long
    }
  }
}

--software-update-options (структура)

Параметры обновления программного обеспечения для домена.

AutoSoftwareUpdateEnabled -> (булево)

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

Сокращенная запись:

AutoSoftwareUpdateEnabled=boolean

Формат JSON:

{
  "AutoSoftwareUpdateEnabled": true|false
}

--aiml-options (структура)

Параметры всех функций машинного обучения для указанного домена.

NaturalLanguageQueryGenerationOptions -> (структура)

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

DesiredState -> (строка)

Желаемое состояние функции генерации запросов на естественном языке. Допустимые значения — ENABLED и DISABLED.

Сокращенная синтаксическая запись:

NaturalLanguageQueryGenerationOptions={DesiredState=string}

Синтаксис JSON:

{
  "NaturalLanguageQueryGenerationOptions": {
    "DesiredState": "ENABLED"|"DISABLED"
  }
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Передача произвольных двоичных значений с помощью значения, предоставленного в JSON, невозможна, поскольку строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись в журнал.

--endpoint-url (строка)

Переопределить значение URL по умолчанию для команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

json
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/отключение цветного вывода.

on
off
auto

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо правильно отформатировать для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров CLI.

Вывод

DomainStatus -> (структура)

Состояние недавно созданного домена.

DomainId -> (строка)

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

DomainName -> (строка)

Имя домена. Имена доменов уникальны для всех доменов, принадлежащих одному аккаунту в регионе Amazon Web Services.

ARN -> (строка)

Amazon Resource Name (ARN) домена. Дополнительную информацию см. в руководстве пользователя AWS Identity and Access Management по идентификаторам IAM.

Created -> (логическое значение)

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

Deleted -> (логическое значение)

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

Endpoint -> (строка)

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

EndpointV2 -> (строка)

Если IPAddressType, для настройки dualstack, предоставляется конечная точка домена версии 2. Эта конечная точка работает как обычная, за исключением того, что она совместима с IPv4 и IPv6 адресами. Обычные конечные точки работают только с IPv4 адресами.

Endpoints -> (отображение)

Пара ключ-значение, которая существует, если домен OpenSearch Service использует VPC конечные точки. Например:

IPv4 IP адреса - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
IP адреса с двойной стековой поддержкой - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

key -> (строка)

value -> (строка)

Конечная точка домена, в которую отправляются запросы индексации и поиска. Например, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com или doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

DomainEndpointV2HostedZoneId -> (строка)

Идентификатор хостированной зоны с двойной стековой поддержкой для домена.

Processing -> (логическое значение)

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

UpgradeProcessing -> (логическое значение)

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

EngineVersion -> (строка)

Версия OpenSearch или Elasticsearch, на которой работает домен, в формате Elasticsearch_X.Y или OpenSearch_X.Y.

ClusterConfig -> (структура)

Контейнер для конфигурации кластера домена.

InstanceType -> (строка)

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

InstanceCount -> (целое число)

Количество узлов данных в кластере. Это число должно быть больше 1, в противном случае возникает исключение валидации.

DedicatedMasterEnabled -> (логическое значение)

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

ZoneAwarenessEnabled -> (логическое значение)

Указывает, включены ли несколько зон доступности. Дополнительную информацию см. в разделе Настройка домена с несколькими зонами доступности в Amazon OpenSearch Service.

ZoneAwarenessConfig -> (структура)

Контейнер для параметров конфигурации с поддержкой нескольких зон доступности. Требуется только если ZoneAwarenessEnabled равно true.

AvailabilityZoneCount -> (целое число)

Если вы включили несколько зон доступности, это значение равно количеству зон, которые вы хотите использовать для домена. Допустимые значения — 2 и 3. Если ваш домен развернут в VPC, это значение будет равно количеству подсетей.

DedicatedMasterType -> (строка)

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

DedicatedMasterCount -> (целое число)

Количество выделенных мастер-узлов в кластере. Это число должно быть больше 2 и не равно 4, иначе возникает исключение валидации.

WarmEnabled -> (логическое значение)

Включить ли тепловое хранилище для кластера.

WarmType -> (строка)

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

WarmCount -> (целое число)

Количество тепловых узлов в кластере.

ColdStorageOptions -> (структура)

Контейнер для параметров конфигурации холодного хранилища.

Enabled -> (логическое значение)

Включить или выключить холодное хранилище в домене. Для включения холодного хранилища необходимо включить UltraWarm хранилище.

MultiAZWithStandbyEnabled -> (логическое значение)

Логическое значение, указывающее, включен ли домен с несколькими зонами доступности со вспомогательной зоной. Дополнительную информацию см. в разделе Настройка домена с несколькими зонами доступности в Amazon OpenSearch Service.

NodeOptions -> (список)

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

(структура)

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

NodeType -> (строка)

Определяет тип узла, например, координационные узлы.

NodeConfig -> (структура)

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

Enabled -> (логическое значение)

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

Type -> (строка)

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

Count -> (целое число)

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

EBSOptions -> (структура)

Контейнер для настроек хранилища на основе EBS для домена.

EBSEnabled -> (логическое значение)

Указывает, подключены ли тома EBS к узлам данных в домене OpenSearch Service.

VolumeType -> (строка)

Указывает тип томов EBS, подключенных к узлам данных.

VolumeSize -> (целое число)

Указывает размер (в ГБ) томов EBS, подключенных к узлам данных.

Iops -> (целое число)

Указывает базовые характеристики ввода/вывода (I/O) томов EBS, подключенных к узлам данных. Применимо только для типов томов EBS с gp3 и предоставленными IOPS.

Throughput -> (целое число)

Указывает пропускную способность (в МБ/с) томов EBS, подключенных к узлам данных. Применимо только для типа томов gp3.

AccessPolicies -> (строка)

Документ политики Identity and Access Management (IAM), определяющий политики доступа к домену.

IPAddressType -> (строка)

Тип IP-адресов, поддерживаемых конечной точкой для домена.

SnapshotOptions -> (структура)

УСТЕРЕЖЕН. Контейнер для параметров, необходимых для настройки автоматических снимков индексов домена.

AutomatedSnapshotStartHour -> (целое число)

Время в формате UTC, когда OpenSearch Service делает ежедневный автоматический снимок указанного домена. По умолчанию 0 часов.

VPCOptions -> (структура)

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

VPCId -> (строка)

Идентификатор вашей VPC. Amazon VPC генерирует это значение при создании VPC.

SubnetIds -> (список)

Список идентификаторов подсетей, связанных с VPC конечными точками домена.

(строка)

AvailabilityZones -> (список)

Список зон доступности, связанных с подсетями VPC.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности, связанных с VPC конечными точками домена.

(строка)

CognitoOptions -> (структура)

Пары ключ-значение для настройки аутентификации Amazon Cognito для OpenSearch Dashboards.

Enabled -> (логическое значение)

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

UserPoolId -> (строка)

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

IdentityPoolId -> (строка)

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

RoleArn -> (строка)

AmazonOpenSearchServiceCognitoAccess роль, позволяющая OpenSearch Service настроить ваш пул пользователей и пул идентификаторов.

EncryptionAtRestOptions -> (структура)

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

Enabled -> (логическое значение)

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

KmsKeyId -> (строка)

Идентификатор ключа KMS. Формат: 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

NodeToNodeEncryptionOptions -> (структура)

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

Enabled -> (логическое значение)

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

AdvancedOptions -> (отображение)

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

key -> (строка)

value -> (строка)

LogPublishingOptions -> (отображение)

Параметры публикации логов для домена.

key -> (строка)

Тип файла лога. Может быть одним из следующих:

INDEX_SLOW_LOGS - Логи медленных запросов индекса содержат запросы вставки, которые потребовали больше времени, чем заданный порог времени выполнения запроса, для выполнения.
SEARCH_SLOW_LOGS - Логи медленных запросов поиска содержат запросы поиска, которые потребовали больше времени, чем заданный порог времени выполнения запроса, для выполнения.
ES_APPLICATION_LOGS - Логи приложения OpenSearch содержат информацию об ошибках и предупреждениях, возникающих во время работы сервиса, и могут быть полезны для устранения неполадок.
AUDIT_LOGS - Логи аудита содержат записи о пользовательских запросах доступа к домену.

value -> (структура)

Указывает, публикует ли Amazon OpenSearch Service логи приложения OpenSearch и медленные запросы в Amazon CloudWatch. Дополнительную информацию см. в разделе Мониторинг логов OpenSearch с помощью Amazon CloudWatch Logs.

Примечание

После включения публикации логов необходимо также включить сбор медленных запросов с помощью API OpenSearch REST.

CloudWatchLogsLogGroupArn -> (строка)

Amazon Resource Name (ARN) группы CloudWatch Logs для публикации логов.

Enabled -> (логическое значение)

Публиковать ли лог.

ServiceSoftwareOptions -> (структура)

Текущий статус программного обеспечения службы домена.

CurrentVersion -> (строка)

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

NewVersion -> (строка)

Новая версия программного обеспечения службы, если она доступна.

UpdateAvailable -> (булево)

Истина, если вы можете обновить версию программного обеспечения службы. Ложь, если вы не можете обновить версию программного обеспечения службы.

Cancellable -> (булево)

Истина, если вы можете отменить обновление версии программного обеспечения службы. Ложь, если вы не можете отменить обновление службы.

UpdateStatus -> (строка)

Статус обновления программного обеспечения службы.

Description -> (строка)

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

AutomatedUpdateDate -> (метка времени)

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

OptionalDeployment -> (булево)

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

DomainEndpointOptions -> (структура)

Дополнительные параметры для конечной точки домена, такие как необходимость HTTPS для всего трафика.

EnforceHTTPS -> (булево)

Истина, чтобы потребовать, чтобы весь трафик домена поступал по HTTPS.

TLSSecurityPolicy -> (строка)

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

Policy-Min-TLS-1-0-2019-07: Политика безопасности TLS, поддерживающая версии TLS от 1.0 до 1.2
Policy-Min-TLS-1-2-2019-07: Политика безопасности TLS, поддерживающая только версию TLS 1.2
Policy-Min-TLS-1-2-PFS-2023-10: Политика безопасности TLS, поддерживающая версии TLS от 1.2 до 1.3 с шифрами с совершенной прямой секретностью

CustomEndpointEnabled -> (булево)

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

CustomEndpoint -> (строка)

Полный URL пользовательской конечной точки.

CustomEndpointCertificateArn -> (строка)

ARN вашего сертификата безопасности, управляемого в Amazon Web Services Certificate Manager (ACM).

AdvancedSecurityOptions -> (структура)

Настройки для тонкого управления доступом.

Enabled -> (булево)

Истина, если управление доступом включено.

InternalUserDatabaseEnabled -> (булево)

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

SAMLOptions -> (структура)

Контейнер для информации о конфигурации SAML для OpenSearch Dashboards.

Enabled -> (булево)

Истина, если SAML включен.

Idp -> (структура)

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

MetadataContent -> (строка)

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

EntityId -> (строка)

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

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

SessionTimeoutMinutes -> (целое)

Длительность в минутах, после которой сессия пользователя становится неактивной.

JWTOptions -> (структура)

Контейнер для информации о конфигурации JWT Amazon OpenSearch Service.

Enabled -> (булево)

Истина, если используется JWT.

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

PublicKey -> (строка)

Ключ, используемый для проверки подписи входящих запросов JWT.

AnonymousAuthDisableDate -> (метка времени)

Дата и время отключения периода миграции. Требуется только при включении тонкого управления доступом в существующем домене.

AnonymousAuthEnabled -> (булево)

Истина, если включен 30-дневный период миграции, в течение которого администраторы могут создавать сопоставления ролей. Требуется только при включении тонкого управления доступом в существующем домене.

IdentityCenterOptions -> (структура)

Параметры конфигурации для управления интеграцией IAM Identity Center в домене.

EnabledAPIAccess -> (булево)

Указывает, включен ли IAM Identity Center для приложения.

IdentityCenterInstanceARN -> (строка)

Amazon Resource Name (ARN) экземпляра IAM Identity Center.

SubjectKey -> (строка)

Указывает атрибут, содержащий идентификатор субъекта (например, имя пользователя, идентификатор пользователя или электронная почта) в IAM Identity Center.

RolesKey -> (строка)

IdentityCenterApplicationARN -> (строка)

ARN приложения IAM Identity Center, которое интегрируется с Amazon OpenSearch Service.

IdentityStoreId -> (строка)

Идентификатор хранилища IAM Identity.

AutoTuneOptions -> (структура)

Настройки Автонастройки для домена.

State -> (строка)

Текущее состояние Автонастройки в домене.

ErrorMessage -> (строка)

Любые ошибки, возникшие во время включения или выключения Автонастройки.

UseOffPeakWindow -> (булево)

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

ChangeProgressDetails -> (структура)

Информация о происходящем изменении конфигурации в домене.

ChangeId -> (строка)

Идентификатор изменения конфигурации.

Message -> (строка)

Сообщение, соответствующее статусу изменения конфигурации.

ConfigChangeStatus -> (строка)

Текущий статус изменения конфигурации.

InitiatedBy -> (строка)

IAM-принципал, инициировавший изменение конфигурации.

StartTime -> (метка времени)

Время инициирования изменения конфигурации в координированном универсальном времени (UTC).

LastUpdatedTime -> (метка времени)

Последнее время обновления изменения конфигурации.

OffPeakWindowOptions -> (структура)

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

Enabled -> (булево)

Включить ли окно вне пиковой нагрузки.

Этот параметр доступен только при изменении домена, созданного до 16 февраля 2023 года, а не при создании нового домена. Для всех доменов, созданных после этой даты, окно вне пиковой нагрузки включено по умолчанию. После включения окна вне пиковой нагрузки для домена его нельзя отключить.

OffPeakWindow -> (структура)

Настройки окна вне пиковой нагрузки для домена.

WindowStartTime -> (структура)

Пользовательское начальное время для окна вне пиковой нагрузки в координированном универсальном времени (UTC). Длительность окна всегда составляет 10 часов, поэтому указать конечное время нельзя. Например, если вы укажете 23:00 UTC как начальное время, конечное время будет автоматически установлено на 9:00.

Hours -> (длинное целое)

Начальный час окна в координированном универсальном времени (UTC) с использованием 24-часового формата. Например, 17 означает 17:00 UTC.

Minutes -> (длинное целое)

Начальная минута окна в UTC.

SoftwareUpdateOptions -> (структура)

Параметры обновления программного обеспечения службы для домена.

AutoSoftwareUpdateEnabled -> (булево)

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

DomainProcessingStatus -> (строка)

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

ModifyingProperties -> (список)

Информация о свойствах домена, которые в настоящее время изменяются.

(структура)

Информация о свойствах домена, которые в настоящее время изменяются.

Name -> (строка)

Имя свойства, которое в настоящее время изменяется.

ActiveValue -> (строка)

Текущее значение свойства домена, которое изменяется.

PendingValue -> (строка)

Значение, которое будет иметь свойство, которое в настоящее время изменяется.

ValueType -> (строка)

Тип значения, которое в настоящее время изменяется. Свойства могут иметь два типа:

PLAIN_TEXT: Содержат прямые значения, такие как «1», «True» или «c5.large.search».
STRINGIFIED_JSON: Содержат содержимое в формате JSON, например, {“Enabled”:”True”}”.

AIMLOptions -> (структура)

Контейнер для параметров, необходимых для включения всех функций машинного обучения.

NaturalLanguageQueryGenerationOptions -> (структура)

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

DesiredState -> (строка)

Желаемое состояние функции генерации запросов на естественном языке. Допустимые значения — ENABLED и DISABLED.

CurrentState -> (строка)

Текущее состояние функции генерации запросов на естественном языке, указывающее завершение, выполнение или ошибку.