обновить-настройки-домена

Описание

Изменяет конфигурацию кластера указанного домена Amazon OpenSearch Service.

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

Синтаксис

  update-domain-config
--domain-name <value>
[--cluster-config <value>]
[--ebs-options <value>]
[--snapshot-options <value>]
[--vpc-options <value>]
[--cognito-options <value>]
[--advanced-options <value>]
[--access-policies <value>]
[--ip-address-type <value>]
[--log-publishing-options <value>]
[--encryption-at-rest-options <value>]
[--domain-endpoint-options <value>]
[--node-to-node-encryption-options <value>]
[--advanced-security-options <value>]
[--identity-center-options <value>]
[--auto-tune-options <value>]
[--dry-run | --no-dry-run]
[--dry-run-mode <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 (строка)

Имя домена, который вы обновляете.

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

Изменения, которые вы хотите внести в конфигурацию кластера, такие как тип экземпляра и количество EC2 экземпляров.

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 -> (целое число)

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

Синтаксис 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, который необходимо подключить к экземплярам в домене.

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
}

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

Возможность установить время в формате UTC для ежедневного автоматического снимка. Значение по умолчанию — 0 часов.

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

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

Сокращённый синтаксис:

AutomatedSnapshotStartHour=integer

Синтаксис JSON:

{
  "AutomatedSnapshotStartHour": integer
}

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

Параметры для указания подсетей и групп безопасности для конечной точки VPC. Дополнительную информацию см. в статье «Запуск ваших домена 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 для OpenSearch Dashboards.

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

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

UserPoolId -> (строка)

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

IdentityPoolId -> (строка)

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

RoleArn -> (строка)

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

Сокращённый синтаксис:

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

Синтаксис JSON:

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

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

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

key -> (строка)

value -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

Политика доступа Identity and Access Management (IAM) в формате JSON.

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

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

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

ipv4
dualstack

--log-publishing-options (отображение)

Параметры для публикации журналов OpenSearch в Amazon CloudWatch Logs.

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.

CloudWatchLogsLogGroupArn -> (строка)

Amazon Resource Name (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
    }
  ...}

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

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

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

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

KmsKeyId -> (строка)

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

Сокращённый синтаксис:

Enabled=boolean,KmsKeyId=string

Синтаксис JSON:

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

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

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

EnforceHTTPS -> (boolean)

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

TLSSecurityPolicy -> (string)

Укажите политику безопасности 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 с совершенной прямой секретностью (perfect forward secrecy) шифров

CustomEndpointEnabled -> (boolean)

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

CustomEndpoint -> (string)

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

CustomEndpointCertificateArn -> (string)

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"
}

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

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

Enabled -> (boolean)

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

Синтаксис сокращённой записи:

Enabled=boolean

Синтаксис JSON:

{
  "Enabled": true|false
}

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

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

Enabled -> (boolean)

True — для включения точного контроля доступа.

InternalUserDatabaseEnabled -> (boolean)

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

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

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

MasterUserARN -> (строка)

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

MasterUserName -> (строка)

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

MasterUserPassword -> (строка)

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

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

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

Enabled -> (boolean)

True — для включения аутентификации 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 -> (boolean)

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

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

PublicKey -> (строка)

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

AnonymousAuthEnabled -> (boolean)

True — для включения 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 -> (boolean)

Указывает, включен ли 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"
}

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

Параметры для Авто-тюнинга.

DesiredState -> (строка)

Включен или выключен Авто-тюнинг.

RollbackOnDisable -> (строка)

При отключении Авто-тюнинга укажите NO_ROLLBACK , чтобы сохранить все предыдущие настройки Авто-тюнинга, или DEFAULT_ROLLBACK , чтобы вернуться к значениям по умолчанию OpenSearch Service. Если вы укажете DEFAULT_ROLLBACK , вы должны включить MaintenanceSchedule в запросе. В противном случае OpenSearch Service не сможет выполнить откат.

MaintenanceSchedules -> (список)

УСТЕРЕЖЕННО. Используйте вместо этого окно вне пиковых нагрузок.

Список планов технического обслуживания, во время которых 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 -> (boolean)

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

Синтаксис JSON:

{
  "DesiredState": "ENABLED"|"DISABLED",
  "RollbackOnDisable": "NO_ROLLBACK"|"DEFAULT_ROLLBACK",
  "MaintenanceSchedules": [
    {
      "StartAt": timestamp,
      "Duration": {
        "Value": long,
        "Unit": "HOURS"
      },
      "CronExpressionForRecurrence": "string"
    }
    ...
  ],
  "UseOffPeakWindow": true|false
}

--dry-run | --no-dry-run (boolean)

Этот флаг, при установке в True, указывает, должен ли запрос UpdateDomain возвращать результаты анализа пробного запуска без фактического применения изменения. Пробный запуск определяет тип развертывания, которое вызовет обновление.

--dry-run-mode (строка)

Тип пробного запуска.

Basic только возвращает тип развертывания (синий/зелёный или динамический), который вызовет обновление.
Verbose выполняет дополнительную проверку для валидации производимых изменений. Дополнительная информация в разделе Валидация обновления домена .

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

Basic
Verbose

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

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

Enabled -> (boolean)

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

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

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

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

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

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

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 -> (boolean)

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

Синтаксис сокращённой записи:

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
текст
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

включено
выключено
автоматически

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

Вывод

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

Статус обновлённого домена.

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

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

Options -> (строка)

Версия OpenSearch или Elasticsearch для указанного домена.

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

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

CreationDate -> (временная метка)

Временная метка создания сущности.

UpdateDate -> (временная метка)

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

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево значение)

Указывает, удаляется ли сущность.

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

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

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

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

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 -> (целое число)

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

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

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

CreationDate -> (временная метка)

Временная метка создания сущности.

UpdateDate -> (временная метка)

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

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево значение)

Указывает, удаляется ли сущность.

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

Контейнер для параметров EBS, настроенных для домена.

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

Настроенные параметры EBS для указанного домена.

EBSEnabled -> (булево значение)

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

VolumeType -> (строка)

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

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

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

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

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

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

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

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

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

CreationDate -> (временная метка)

Временная метка создания сущности.

UpdateDate -> (временная метка)

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

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево значение)

Указывает, удаляется ли сущность.

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

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

Options -> (строка)

Настроенная политика доступа к домену. Политики доступа могут быть основанные на ресурсах, на основе IP-адресов или на основе IAM. Дополнительную информацию см. в разделе Настройка политик доступа.

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

Статус политики доступа к домену.

CreationDate -> (временная метка)

Временная метка создания сущности.

UpdateDate -> (временная метка)

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

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево значение)

Указывает, удаляется ли сущность.

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

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

Options -> (строка)

Параметры IP-адреса для домена.

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

Предоставляет текущий статус сущности.

CreationDate -> (временная метка)

Временная метка создания сущности.

UpdateDate -> (временная метка)

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

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево значение)

Указывает, удаляется ли сущность.

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

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

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

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

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

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

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

Статус ежедневного автоматического снимка.

CreationDate -> (временная метка)

Временная метка создания сущности.

UpdateDate -> (временная метка)

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

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево значение)

Указывает, удаляется ли сущность.

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

Текущие параметры VPC для домена и статус любых обновлений их конфигурации.

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

Параметры VPC для указанного домена.

VPCId -> (строка)

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

SubnetIds -> (список)

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

(строка)

AvailabilityZones -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

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

CreationDate -> (временная метка)

Временная метка создания сущности.

UpdateDate -> (временная метка)

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

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево значение)

Указывает, удаляется ли сущность.

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

Контейнер для параметров Amazon Cognito для домена.

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

Параметры Cognito для указанного домена.

Enabled -> (булево значение)

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

UserPoolId -> (строка)

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

IdentityPoolId -> (строка)

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

RoleArn -> (строка)

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

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

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

CreationDate -> (временная метка)

Временная метка создания сущности.

UpdateDate -> (временная метка)

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

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево значение)

Указывает, удаляется ли сущность.

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

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

Параметры -> (структура)

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

Включено -> (булево)

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

KmsKeyId -> (строка)

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

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

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

ДатаСоздание -> (метка времени)

Метка времени создания сущности.

ДатаОбновления -> (метка времени)

Метка времени последнего обновления сущности.

ВерсияОбновления -> (целое число)

Последняя версия сущности.

Состояние -> (строка)

Состояние сущности.

ОжидаетсяУдаление -> (булево)

Указывает, удаляется ли сущность.

ПараметрыШифрованияМеждуУзлами -> (структура)

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

Параметры -> (структура)

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

Включено -> (булево)

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

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

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

ДатаСоздание -> (метка времени)

Метка времени создания сущности.

ДатаОбновления -> (метка времени)

Метка времени последнего обновления сущности.

ВерсияОбновления -> (целое число)

Последняя версия сущности.

Состояние -> (строка)

Состояние сущности.

ОжидаетсяУдаление -> (булево)

Указывает, удаляется ли сущность.

ДополнительныеПараметры -> (структура)

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

Параметры -> (карта)

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

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

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

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

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

ДатаСоздание -> (метка времени)

Метка времени создания сущности.

ДатаОбновления -> (метка времени)

Метка времени последнего обновления сущности.

ВерсияОбновления -> (целое число)

Последняя версия сущности.

Состояние -> (строка)

Состояние сущности.

ОжидаетсяУдаление -> (булево)

Указывает, удаляется ли сущность.

ПараметрыПубликацииЛогов -> (структура)

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

Параметры -> (карта)

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

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

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

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

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

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

Примечание

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

CloudWatchLogsLogGroupArn -> (строка)

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

Включено -> (булево)

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

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

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

ДатаСоздание -> (метка времени)

Метка времени создания сущности.

ДатаОбновления -> (метка времени)

Метка времени последнего обновления сущности.

ВерсияОбновления -> (целое число)

Последняя версия сущности.

Состояние -> (строка)

Состояние сущности.

ОжидаетсяУдаление -> (булево)

Указывает, удаляется ли сущность.

ПараметрыКонечнойТочкиДомена -> (структура)

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

Параметры -> (структура)

Параметры для настройки конечной точки домена.

ВыполнятьHTTPS -> (булево)

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

ПолитикаTLSБезопасности -> (строка)

Укажите политику безопасности 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 с совершенной пряной секретностью

ВключитьПользовательскуюКонечнуюТочку -> (булево)

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

ПользовательскаяКонечнаяТочка -> (строка)

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

ПользовательскийСертификатКонечнойТочкиArn -> (строка)

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

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

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

ДатаСоздание -> (метка времени)

Метка времени создания сущности.

ДатаОбновления -> (метка времени)

Метка времени последнего обновления сущности.

ВерсияОбновления -> (целое число)

Последняя версия сущности.

Состояние -> (строка)

Состояние сущности.

ОжидаетсяУдаление -> (булево)

Указывает, удаляется ли сущность.

ДополнительныеПараметрыБезопасности -> (структура)

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

Параметры -> (структура)

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

Включено -> (булево)

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

ВключитьБазуДанныхВнутреннихПользователей -> (булево)

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

ПараметрыSAML -> (структура)

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

Включено -> (булево)

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

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

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

СодержимоеМетаданных -> (строка)

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

УникальныйИдентификатор -> (строка)

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

КлючСубъекта -> (строка)

Ключ для сопоставления атрибута субъекта SAML.

КлючРолей -> (строка)

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

ТаймаутСеансаМинуты -> (целое число)

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

ПараметрыJWT -> (структура)

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

Включено -> (булево)

Истина, если включено использование JWT.

КлючСубъекта -> (строка)

Ключ для сопоставления атрибута субъекта JWT.

КлючРолей -> (строка)

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

ОткрытыйКлюч -> (строка)

Ключ для проверки подписи входящих запросов JWT.

ДатаОтключенияБезопасногоАвторизации -> (метка времени)

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

ВключитьБезопасныйАвторизации -> (булево)

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

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

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

ДатаСоздание -> (метка времени)

Метка времени создания сущности.

ДатаОбновления -> (метка времени)

Метка времени последнего обновления сущности.

ВерсияОбновления -> (целое число)

Последняя версия сущности.

Состояние -> (строка)

Состояние сущности.

ОжидаетсяУдаление -> (булево)

Указывает, удаляется ли сущность.

ПараметрыЦентраУдостоверений -> (структура)

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

Параметры -> (структура)

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

ВключитьДоступЧерезAPI -> (булево)

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

ArnИнстансаЦентраУдостоверений -> (строка)

Идентификатор ресурса Amazon (ARN) экземпляра IAM Identity Center.

КлючСубъекта -> (строка)

КлючРолей -> (строка)

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

ArnПриложенияЦентраУдостоверений -> (строка)

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

IdИдентификатораХранилищаУдостоверений -> (строка)

Идентификатор хранилища удостоверений IAM.

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

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

ДатаСоздание -> (метка времени)

Метка времени создания сущности.

ДатаОбновления -> (метка времени)

Метка времени последнего обновления сущности.

ВерсияОбновления -> (целое число)

Последняя версия сущности.

Состояние -> (строка)

Состояние сущности.

ОжидаетсяУдаление -> (булево)

Указывает, удаляется ли сущность.

ПараметрыАвтоНастроек -> (структура)

Контейнер для настроек Авто-тюна для домена.

Параметры -> (структура)

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

DesiredState -> (строка)

Включен или выключен Авто-тюн.

RollbackOnDisable -> (строка)

При отключении Авто-тюна, укажите NO_ROLLBACK, чтобы сохранить все предыдущие настройки Авто-тюна, или DEFAULT_ROLLBACK, чтобы вернуться к значениям по умолчанию OpenSearch Service. Если вы укажете DEFAULT_ROLLBACK, вы должны включить MaintenanceSchedule в запросе. В противном случае, OpenSearch Service не сможет выполнить откат.

MaintenanceSchedules -> (список)

УСТАРЕЛО. Используйте вместо этого окно вне пиковой нагрузки.

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

(структура)

Примечание

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

График технического обслуживания Авто-тюна. Дополнительную информацию см. в разделе Авто-тюн для Amazon OpenSearch Service.

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

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

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

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

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

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

Unit -> (строка)

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

CronExpressionForRecurrence -> (строка)

Выражение cron для периодического графика технического обслуживания, в течение которого Авто-тюн может развернуть изменения.

UseOffPeakWindow -> (булево)

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

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

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

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

Дата и время включения Авто-тюна для домена.

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

Дата и время последнего обновления параметров Авто-тюна для домена.

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

Последняя версия параметров Авто-тюна.

State -> (строка)

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

ErrorMessage -> (строка)

Возникшие ошибки при включении или отключении Авто-тюна.

PendingDeletion -> (булево)

Указывает, удаляется ли домен.

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

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

ChangeId -> (строка)

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

Message -> (строка)

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

ConfigChangeStatus -> (строка)

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

InitiatedBy -> (строка)

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

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

Время инициирования изменения конфигурации в формате UTC.

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

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

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

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

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

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

Enabled -> (булево)

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

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

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

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

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

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

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

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

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

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

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

Текущий статус параметров окна вне пиковой нагрузки.

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

Метка времени создания сущности.

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

Метка времени последнего обновления сущности.

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево)

Указывает, удаляется ли сущность.

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

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

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

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

AutoSoftwareUpdateEnabled -> (булево)

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

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

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

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

Метка времени создания сущности.

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

Метка времени последнего обновления сущности.

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево)

Указывает, удаляется ли сущность.

ModifyingProperties -> (список)

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

(структура)

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

Name -> (строка)

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

ActiveValue -> (строка)

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

PendingValue -> (строка)

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

ValueType -> (строка)

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

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

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

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

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

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

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

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

DesiredState -> (строка)

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

CurrentState -> (строка)

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

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

Предоставляет текущий статус сущности.

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

Метка времени создания сущности.

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

Метка времени последнего обновления сущности.

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

Последняя версия сущности.

State -> (строка)

Состояние сущности.

PendingDeletion -> (булево)

Указывает, удаляется ли сущность.

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

Результаты выполнения предварительного анализа в запросе обновления домена.

DeploymentType -> (строка)

Указывает способ применения OpenSearch Service обновления. Возможные значения:

Синий/зеленый - Обновление требует развертывания синего/зеленого.
DynamicUpdate - Развертывание синего/зеленого не требуется
Undetermined - Домен находится в процессе обновления и не может предсказать тип развертывания. Повторите попытку после завершения обновления.
None - Запрос не содержит изменений конфигурации.

Message -> (строка)

Сообщение, соответствующее типу развертывания.

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

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

DryRunId -> (строка)

Уникальный идентификатор предварительного анализа.

DryRunStatus -> (строка)

Текущий статус предварительного анализа.

CreationDate -> (строка)

Метка времени начала предварительного анализа.

UpdateDate -> (строка)

Метка времени последнего обновления предварительного анализа.

ValidationFailures -> (список)

Возникшие ошибки проверки в результате предварительного анализа.

(структура)

Ошибка проверки, возникшая в результате проверки перед обновлением (подробный предварительный анализ) домена.

Code -> (строка)

Код ошибки.

Message -> (строка)

Сообщение, соответствующее ошибке.