update-elasticsearch-domain-config

Описание

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

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

Синтаксис

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

Название домена Elasticsearch, который вы обновляете.

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

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

InstanceType -> (строка)

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

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

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

DedicatedMasterEnabled -> (булево)

Булево значение, указывающее, включен ли выделенный мастер-узел. Дополнительную информацию см. в разделе О выделенных мастер-узлах.

ZoneAwarenessEnabled -> (булево)

Булево значение, указывающее, включено ли зональное разграничение. Дополнительную информацию см. в разделе О зональном разграничении.

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

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

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

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

DedicatedMasterType -> (строка)

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

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

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

WarmEnabled -> (булево)

Истина, если включено хранилище тёплых данных.

WarmType -> (строка)

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

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

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

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

Определяет конфигурацию ColdStorageOptions для домена Elasticsearch

Enabled -> (булево)

Включить опцию холодного хранения. Допустимые значения true или false

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

InstanceType=string,InstanceCount=integer,DedicatedMasterEnabled=boolean,ZoneAwarenessEnabled=boolean,ZoneAwarenessConfig={AvailabilityZoneCount=integer},DedicatedMasterType=string,DedicatedMasterCount=integer,WarmEnabled=boolean,WarmType=string,WarmCount=integer,ColdStorageOptions={Enabled=boolean}

JSON-синтаксис:

{
  "InstanceType": "m3.medium.elasticsearch"|"m3.large.elasticsearch"|"m3.xlarge.elasticsearch"|"m3.2xlarge.elasticsearch"|"m4.large.elasticsearch"|"m4.xlarge.elasticsearch"|"m4.2xlarge.elasticsearch"|"m4.4xlarge.elasticsearch"|"m4.10xlarge.elasticsearch"|"m5.large.elasticsearch"|"m5.xlarge.elasticsearch"|"m5.2xlarge.elasticsearch"|"m5.4xlarge.elasticsearch"|"m5.12xlarge.elasticsearch"|"r5.large.elasticsearch"|"r5.xlarge.elasticsearch"|"r5.2xlarge.elasticsearch"|"r5.4xlarge.elasticsearch"|"r5.12xlarge.elasticsearch"|"c5.large.elasticsearch"|"c5.xlarge.elasticsearch"|"c5.2xlarge.elasticsearch"|"c5.4xlarge.elasticsearch"|"c5.9xlarge.elasticsearch"|"c5.18xlarge.elasticsearch"|"ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch"|"t2.micro.elasticsearch"|"t2.small.elasticsearch"|"t2.medium.elasticsearch"|"r3.large.elasticsearch"|"r3.xlarge.elasticsearch"|"r3.2xlarge.elasticsearch"|"r3.4xlarge.elasticsearch"|"r3.8xlarge.elasticsearch"|"i2.xlarge.elasticsearch"|"i2.2xlarge.elasticsearch"|"d2.xlarge.elasticsearch"|"d2.2xlarge.elasticsearch"|"d2.4xlarge.elasticsearch"|"d2.8xlarge.elasticsearch"|"c4.large.elasticsearch"|"c4.xlarge.elasticsearch"|"c4.2xlarge.elasticsearch"|"c4.4xlarge.elasticsearch"|"c4.8xlarge.elasticsearch"|"r4.large.elasticsearch"|"r4.xlarge.elasticsearch"|"r4.2xlarge.elasticsearch"|"r4.4xlarge.elasticsearch"|"r4.8xlarge.elasticsearch"|"r4.16xlarge.elasticsearch"|"i3.large.elasticsearch"|"i3.xlarge.elasticsearch"|"i3.2xlarge.elasticsearch"|"i3.4xlarge.elasticsearch"|"i3.8xlarge.elasticsearch"|"i3.16xlarge.elasticsearch",
  "InstanceCount": integer,
  "DedicatedMasterEnabled": true|false,
  "ZoneAwarenessEnabled": true|false,
  "ZoneAwarenessConfig": {
    "AvailabilityZoneCount": integer
  },
  "DedicatedMasterType": "m3.medium.elasticsearch"|"m3.large.elasticsearch"|"m3.xlarge.elasticsearch"|"m3.2xlarge.elasticsearch"|"m4.large.elasticsearch"|"m4.xlarge.elasticsearch"|"m4.2xlarge.elasticsearch"|"m4.4xlarge.elasticsearch"|"m4.10xlarge.elasticsearch"|"m5.large.elasticsearch"|"m5.xlarge.elasticsearch"|"m5.2xlarge.elasticsearch"|"m5.4xlarge.elasticsearch"|"m5.12xlarge.elasticsearch"|"r5.large.elasticsearch"|"r5.xlarge.elasticsearch"|"r5.2xlarge.elasticsearch"|"r5.4xlarge.elasticsearch"|"r5.12xlarge.elasticsearch"|"c5.large.elasticsearch"|"c5.xlarge.elasticsearch"|"c5.2xlarge.elasticsearch"|"c5.4xlarge.elasticsearch"|"c5.9xlarge.elasticsearch"|"c5.18xlarge.elasticsearch"|"ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch"|"t2.micro.elasticsearch"|"t2.small.elasticsearch"|"t2.medium.elasticsearch"|"r3.large.elasticsearch"|"r3.xlarge.elasticsearch"|"r3.2xlarge.elasticsearch"|"r3.4xlarge.elasticsearch"|"r3.8xlarge.elasticsearch"|"i2.xlarge.elasticsearch"|"i2.2xlarge.elasticsearch"|"d2.xlarge.elasticsearch"|"d2.2xlarge.elasticsearch"|"d2.4xlarge.elasticsearch"|"d2.8xlarge.elasticsearch"|"c4.large.elasticsearch"|"c4.xlarge.elasticsearch"|"c4.2xlarge.elasticsearch"|"c4.4xlarge.elasticsearch"|"c4.8xlarge.elasticsearch"|"r4.large.elasticsearch"|"r4.xlarge.elasticsearch"|"r4.2xlarge.elasticsearch"|"r4.4xlarge.elasticsearch"|"r4.8xlarge.elasticsearch"|"r4.16xlarge.elasticsearch"|"i3.large.elasticsearch"|"i3.xlarge.elasticsearch"|"i3.2xlarge.elasticsearch"|"i3.4xlarge.elasticsearch"|"i3.8xlarge.elasticsearch"|"i3.16xlarge.elasticsearch",
  "DedicatedMasterCount": integer,
  "WarmEnabled": true|false,
  "WarmType": "ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch",
  "WarmCount": integer,
  "ColdStorageOptions": {
    "Enabled": true|false
  }
}

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

Укажите тип и размер тома EBS, который вы хотите использовать.

EBSEnabled -> (булево)

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

VolumeType -> (строка)

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

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

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

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

Указывает IOPS для томов EBS с выделенными IOPS и GP3 (SSD).

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

Указывает пропускную способность для томов EBS GP3 (SSD).

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

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, когда служба выполняет ежедневный автоматический снимок указанного домена Elasticsearch. Значение по умолчанию — 0 час.

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

AutomatedSnapshotStartHour=integer

JSON-синтаксис:

{
  "AutomatedSnapshotStartHour": integer
}

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

Параметры для указания подсетей и групп безопасности для VPC-шлюза. Дополнительную информацию см. в разделе Создание VPC в VPC-шлюзах для Amazon Elasticsearch Service Domains

SubnetIds -> (список)

Указывает подсети для VPC-шлюза.

(строка)

SecurityGroupIds -> (список)

Указывает группы безопасности для VPC-шлюза.

(строка)

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

SubnetIds=string,string,SecurityGroupIds=string,string

JSON-синтаксис:

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

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

Параметры для указания пользователя Cognito и пулов идентификаторов для аутентификации Kibana. Дополнительную информацию см. в разделе Аутентификация Amazon Cognito для Kibana.

Enabled -> (булево)

Указывает опцию включения Cognito для аутентификации Kibana.

UserPoolId -> (строка)

Указывает идентификатор пула пользователей Cognito для аутентификации Kibana.

IdentityPoolId -> (строка)

Указывает идентификатор пула идентификаторов Cognito для аутентификации Kibana.

RoleArn -> (строка)

Указывает ARN роли, предоставляющей права Elasticsearch для доступа к ресурсам Cognito.

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

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

JSON-синтаксис:

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

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

Изменяет расширенный параметр, разрешающий ссылки на индексы в теле HTTP-запроса. Должно быть false при настройке доступа к отдельным подресурсам. По умолчанию значение равно true. Дополнительную информацию см. в разделе Параметры расширенной конфигурации.

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

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

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

KeyName1=string,KeyName2=string

JSON-синтаксис:

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

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

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

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

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

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

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

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

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

Параметр публикации журнала, настроенный для данного домена. Атрибуты и их подробности:

CloudWatchLogsLogGroupArn: ARN группы журналов CloudWatch, в которую необходимо опубликовать журнал.
Enabled: Включена ли публикация журнала для данного типа журнала

CloudWatchLogsLogGroupArn -> (строка)

ARN группы журналов CloudWatch, в которую необходимо опубликовать журнал.

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 (структура)

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

EnforceHTTPS -> (булево)

Указать, должен ли быть включен только конечный пункт HTTPS для домена Elasticsearch.

TLSSecurityPolicy -> (строка)

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

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 -> (булево)

Указать, должен ли быть включён пользовательский конечный пункт для домена Elasticsearch.

CustomEndpoint -> (строка)

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

CustomEndpointCertificateArn -> (строка)

Указать ARN сертификата 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 -> (структура)

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

MasterUserARN -> (строка)

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

MasterUserName -> (строка)

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

MasterUserPassword -> (строка)

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

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

Определяет конфигурацию приложения SAML для домена.

Enabled -> (булево)

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

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

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

MetadataContent -> (строка)

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

EntityId -> (строка)

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

MasterUserName -> (строка)

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

MasterBackendRole -> (строка)

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

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

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

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

AnonymousAuthEnabled -> (булево)

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

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

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},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
  },
  "AnonymousAuthEnabled": true|false
}

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

Определяет параметры шифрования NodeToNode.

Enabled -> (булево)

Установите значение true, чтобы включить шифрование узлов.

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

Enabled=boolean

JSON-синтаксис:

{
  "Enabled": true|false
}

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

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

Enabled -> (булево)

Указывает, включена ли опция шифрования в состоянии покоя.

KmsKeyId -> (строка)

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

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

Enabled=boolean,KmsKeyId=string

Синтаксис JSON:

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

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

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

DesiredState -> (строка)

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

RollbackOnDisable -> (строка)

Указывает состояние отката при отключении Авто-настройки для домена. Допустимые значения: NO_ROLLBACK, DEFAULT_ROLLBACK.

MaintenanceSchedules -> (список)

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

(структура)

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

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

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

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

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

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

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

Unit -> (строка)

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

CronExpressionForRecurrence -> (строка)

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

Синтаксис JSON:

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

--dry-run | --no-dry-run (логическое значение)

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

--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
таблица
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.

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

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

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

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

Вывод

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

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

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

Строка формата X.Y для указания версии домена Elasticsearch.

Options -> (строка)

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

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

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

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

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

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

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

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

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

State -> (строка)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (булево)

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

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

Указывает ElasticsearchClusterConfig для домена Elasticsearch.

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

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

InstanceType -> (строка)

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

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

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

DedicatedMasterEnabled -> (булево)

Булево значение, указывающее, включён ли выделенный мастер-узел. Дополнительную информацию см. в разделе «О выделенных мастер-узлах».

ZoneAwarenessEnabled -> (булево)

Булево значение, указывающее, включена ли функция зоны доступности. Дополнительную информацию см. в разделе «О зонах доступности».

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

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

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

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

DedicatedMasterType -> (строка)

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

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

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

WarmEnabled -> (булево)

True для включения тёплого хранилища.

WarmType -> (строка)

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

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

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

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

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

Enabled -> (булево)

Включить параметр холодного хранения. Допустимые значения true или false

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

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

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

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

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

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

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

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

State -> (строка)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (булево)

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

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

Указывает EBSOptions для домена Elasticsearch.

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

Указывает параметры EBS для указанного домена Elasticsearch.

EBSEnabled -> (булево)

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

VolumeType -> (строка)

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

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

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

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

Указывает IOPS для тома EBS с предварительно заданным IOPS и GP3 (SSD).

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

Указывает пропускную способность для тома EBS GP3 (SSD).

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

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

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

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

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

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

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

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

State -> (строка)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (булево)

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

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

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

Options -> (строка)

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

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

Статус политики доступа для домена Elasticsearch. Дополнительную информацию о статусе см. в разделе OptionStatus.

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

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

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

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

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

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

State -> (строка)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (булево)

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

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

Указывает SnapshotOptions для домена Elasticsearch.

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

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

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

Указывает время, в формате UTC, когда служба создаёт ежедневный автоматический моментальный снимок указанного домена Elasticsearch. Значение по умолчанию - 0 час.

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

Указывает статус ежедневного автоматического создания моментального снимка.

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

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

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

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

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

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

State -> (строка)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (булево)

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

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

VPCOptions для указанного домена. Дополнительную информацию см. в разделе «VPC-шлюзы для доменов Amazon Elasticsearch Service».

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

Указывает параметры VPC для указанного домена Elasticsearch.

VPCId -> (строка)

Идентификатор VPC для домена Elasticsearch. Существует только в том случае, если домен был создан с VPCOptions.

SubnetIds -> (список)

Указывает подсети для VPC-шлюза.

(строка)

AvailabilityZones -> (список)

Зоны доступности для домена Elasticsearch. Существуют только в том случае, если домен был создан с VPCOptions.

(строка)

SecurityGroupIds -> (список)

Указывает группы безопасности для VPC-шлюза.

(строка)

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

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

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

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

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

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

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

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

State -> (строка)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (булево)

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

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

CognitoOptions для указанного домена. Дополнительную информацию см. в разделе «Аутентификация Amazon Cognito для Kibana».

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

Указывает параметры Cognito для указанного домена Elasticsearch.

Enabled -> (булево)

Указывает параметр для включения Cognito для аутентификации Kibana.

UserPoolId -> (строка)

Указывает идентификатор пула пользователей Cognito для аутентификации Kibana.

IdentityPoolId -> (строка)

Указывает идентификатор пула идентификаторов Cognito для аутентификации Kibana.

RoleArn -> (строка)

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

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

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

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

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

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

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

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

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

State -> (строка)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (булево)

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

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

Указывает EncryptionAtRestOptions для домена Elasticsearch.

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

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

Enabled -> (булево)

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

KmsKeyId -> (строка)

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

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

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

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

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

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

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

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

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

State -> (строка)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (булево)

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

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

Указывает NodeToNodeEncryptionOptions для домена Elasticsearch.

Options -> (structure)

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

Enabled -> (boolean)

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

Status -> (structure)

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

CreationDate -> (timestamp)

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

UpdateDate -> (timestamp)

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

UpdateVersion -> (integer)

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

State -> (string)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (boolean)

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

AdvancedOptions -> (structure)

Указывает AdvancedOptions для домена. Дополнительную информацию см. в разделе «Настройка дополнительных параметров».

Options -> (map)

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

key -> (string)

value -> (string)

Status -> (structure)

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

CreationDate -> (timestamp)

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

UpdateDate -> (timestamp)

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

UpdateVersion -> (integer)

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

State -> (string)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (boolean)

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

LogPublishingOptions -> (structure)

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

Options -> (map)

Настроенные параметры публикации журналов для домена Elasticsearch.

key -> (string)

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

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

value -> (structure)

Настройка публикации журналов для данного домена. Атрибуты и их детали:

CloudWatchLogsLogGroupArn: ARN группы журналов CloudWatch, в которую необходимо опубликовать журналы.
Enabled: Включена ли публикация журналов для данного типа журнала

CloudWatchLogsLogGroupArn -> (string)

ARN группы журналов CloudWatch, в которую необходимо опубликовать журналы.

Enabled -> (boolean)

Указывает, включена ли данная опция публикации журналов.

Status -> (structure)

Состояние параметров публикации журналов для домена Elasticsearch. Смотрите OptionStatus для получения информации о состоянии.

CreationDate -> (timestamp)

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

UpdateDate -> (timestamp)

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

UpdateVersion -> (integer)

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

State -> (string)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (boolean)

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

DomainEndpointOptions -> (structure)

Указывает DomainEndpointOptions для домена Elasticsearch.

Options -> (structure)

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

EnforceHTTPS -> (boolean)

Указать, должен ли быть включён только HTTPS-адрес для домена Elasticsearch.

TLSSecurityPolicy -> (string)

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

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)

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

CustomEndpoint -> (string)

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

CustomEndpointCertificateArn -> (string)

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

Status -> (structure)

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

CreationDate -> (timestamp)

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

UpdateDate -> (timestamp)

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

UpdateVersion -> (integer)

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

State -> (string)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (boolean)

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

AdvancedSecurityOptions -> (structure)

Указывает AdvancedSecurityOptions для домена.

Options -> (structure)

Указывает расширенные параметры безопасности для указанного домена Elasticsearch.

Enabled -> (boolean)

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

InternalUserDatabaseEnabled -> (boolean)

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

SAMLOptions -> (structure)

Описание приложения SAML, настроенного для домена.

Enabled -> (boolean)

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

Idp -> (structure)

Описание сведений об идентификаторе поставщика услуг SAML.

MetadataContent -> (string)

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

EntityId -> (string)

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

SubjectKey -> (string)

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

RolesKey -> (string)

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

SessionTimeoutMinutes -> (integer)

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

AnonymousAuthDisableDate -> (timestamp)

Указывает дату отключения анонимной аутентификации при её включении.

AnonymousAuthEnabled -> (boolean)

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

Status -> (structure)

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

CreationDate -> (timestamp)

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

UpdateDate -> (timestamp)

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

UpdateVersion -> (integer)

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

State -> (string)

Предоставляет OptionState для домена Elasticsearch.

PendingDeletion -> (boolean)

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

AutoTuneOptions -> (structure)

Указывает AutoTuneOptions для домена.

Options -> (structure)

Указывает параметры Auto-Tune для указанного домена Elasticsearch.

DesiredState -> (string)

Указывает желаемое состояние Auto-Tune. Допустимые значения: ENABLED, DISABLED.

RollbackOnDisable -> (string)

Указывает состояние отката при отключении Auto-Tune для домена. Допустимые значения: NO_ROLLBACK, DEFAULT_ROLLBACK.

MaintenanceSchedules -> (list)

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

(structure)

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

StartAt -> (timestamp)

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

Duration -> (structure)

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

Value -> (long)

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

Unit -> (string)

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

CronExpressionForRecurrence -> (string)

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

Status -> (structure)

Указывает состояние параметров Auto-Tune для указанного домена Elasticsearch.

CreationDate -> (timestamp)

Маркер времени создания параметров Auto-Tune.

UpdateDate -> (timestamp)

Маркер времени последнего обновления параметров Auto-Tune.

UpdateVersion -> (integer)

Указывает последнюю версию параметров Auto-Tune.

State -> (string)

Указывает AutoTuneState для домена Elasticsearch.

ErrorMessage -> (string)

Указывает сообщение об ошибке при включении или отключении параметров Auto-Tune.

PendingDeletion -> (boolean)

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

ChangeProgressDetails -> (structure)

Указывает детали изменений в настройках домена.

ChangeId -> (string)

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

Message -> (string)

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

ConfigChangeStatus -> (string)

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

StartTime -> (timestamp)

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

LastUpdatedTime -> (timestamp)

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

InitiatedBy -> (string)

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

ModifyingProperties -> (list)

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

(структура)

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

Имя -> (строка)

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

ТекущееЗначение -> (строка)

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

ПредполагаемоеЗначение -> (строка)

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

ТипЗначения -> (строка)

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

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

РезультатыПрогона -> (структура)

Содержит результат Прогона.

ТипРазвертывания -> (строка)

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

Blue/Green (Для обновления потребуется развертывание синего/зеленого.) DynamicUpdate (Обновление можно применить непосредственно без необходимости развертывания синего/зеленого.) Undetermined (Домен находится в процессе обновления, которое должно завершиться, прежде чем можно будет предсказать тип развертывания.) None (Изменение конфигурации соответствует текущей конфигурации и не приведет к обновлению.)

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

Содержит необязательное сообщение, связанное с РезультатамиПрогона.