создать-домен-elasticsearch

Описание

Создаёт новый домен Elasticsearch. Для получения дополнительной информации см. раздел Создание доменов Elasticsearch в Руководстве разработчика Amazon Elasticsearch Service .

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

Синтаксис

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

Имя создаваемого домена Elasticsearch. Имена доменов уникальны для доменов, принадлежащих учётной записи в регионе AWS. Имя домена должно начинаться с маленькой буквы и может содержать следующие символы: a-z (маленькие буквы), 0-9 и - (тире).

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

Строка формата X.Y для указания версии домена Elasticsearch, например, “1.5” или “2.3”. Для получения дополнительной информации см. раздел Создание доменов Elasticsearch в Руководстве разработчика Amazon Elasticsearch Service .

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

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

InstanceType -> (строка)

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

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

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

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

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

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

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

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

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

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

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

DedicatedMasterType -> (строка)

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

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

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

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

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

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
}

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

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

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

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

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

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

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

AutomatedSnapshotStartHour=integer

Синтаксис JSON:

{
  "AutomatedSnapshotStartHour": integer
}

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

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

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

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

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

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

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

KmsKeyId -> (строка)

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

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

Enabled=boolean,KmsKeyId=string

Синтаксис JSON:

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

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

Указывает параметры NodeToNodeEncryption.

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

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

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

Enabled=boolean

Синтаксис JSON:

{
  "Enabled": true|false
}

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

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

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

key -> (строка)

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

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

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

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

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

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

InternalUserDatabaseEnabled -> (boolean)

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

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

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

MasterUserARN -> (строка)

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

MasterUserName -> (строка)

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

MasterUserPassword -> (строка)

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

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

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

Enabled -> (boolean)

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

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

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

MetadataContent -> (строка)

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

EntityId -> (строка)

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

MasterUserName -> (строка)

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

MasterBackendRole -> (строка)

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

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

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

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

AnonymousAuthEnabled -> (boolean)

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

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

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
}

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

Указывает параметры Auto-Tune.

DesiredState -> (строка)

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

MaintenanceSchedules -> (список)

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

(структура)

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

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

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

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

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

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

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

Unit -> (строка)

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

CronExpressionForRecurrence -> (строка)

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

Синтаксис JSON:

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

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

Список Tag, добавленных во время создания домена.

(структура)

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

Key -> (строка)

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

Value -> (строка)

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

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

Key=string,Value=string ...

Синтаксис JSON:

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

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

Включает отладку.

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

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (строка)

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

json
текст
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

вкл
выкл
авто

--no-sign-request (boolean)

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

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

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

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

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

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

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

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

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

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить страницу cli для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для создания домена Amazon Elasticsearch Service

Следующая create-elasticsearch-domain команда создает новый домен Amazon Elasticsearch Service внутри VPC и ограничивает доступ одному пользователю. Amazon ES определяет идентификатор VPC по указанным идентификаторам подсети и группы безопасности.

aws es create-elasticsearch-domain \
    --domain-name vpc-cli-example \
    --elasticsearch-version 6.2 \
    --elasticsearch-cluster-config InstanceType=m4.large.elasticsearch,InstanceCount=1 \
    --ebs-options EBSEnabled=true,VolumeType=standard,VolumeSize=10 \
    --access-policies '{"Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root" }, "Action":"es:*", "Resource": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*" } ] }' \
    --vpc-options SubnetIds=subnet-1a2a3a4a,SecurityGroupIds=sg-2a3a4a5a

Вывод:

{
    "DomainStatus": {
        "ElasticsearchClusterConfig": {
            "DedicatedMasterEnabled": false,
            "InstanceCount": 1,
            "ZoneAwarenessEnabled": false,
            "InstanceType": "m4.large.elasticsearch"
        },
        "DomainId": "123456789012/vpc-cli-example",
        "CognitoOptions": {
            "Enabled": false
        },
        "VPCOptions": {
            "SubnetIds": [
                "subnet-1a2a3a4a"
            ],
            "VPCId": "vpc-3a4a5a6a",
            "SecurityGroupIds": [
                "sg-2a3a4a5a"
            ],
            "AvailabilityZones": [
                "us-west-1c"
            ]
        },
        "Created": true,
        "Deleted": false,
        "EBSOptions": {
            "VolumeSize": 10,
            "VolumeType": "standard",
            "EBSEnabled": true
        },
        "Processing": true,
        "DomainName": "vpc-cli-example",
        "SnapshotOptions": {
            "AutomatedSnapshotStartHour": 0
        },
        "ElasticsearchVersion": "6.2",
        "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*\"}]}",
        "AdvancedOptions": {
            "rest.action.multi.allow_explicit_index": "true"
        },
        "EncryptionAtRestOptions": {
            "Enabled": false
        },
        "ARN": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example"
    }
}

Дополнительную информацию см. в разделе Создание и управление доменами Amazon Elasticsearch Service в Руководстве разработчика Amazon Elasticsearch Service.

Вывод

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

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

DomainId -> (строка)

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

DomainName -> (строка)

Имя домена Elasticsearch. Имена доменов уникальны для всех доменов, принадлежащих учетной записи в регионе AWS. Имена доменов начинаются с буквы или цифры и могут содержать следующие символы: a-z (строчные буквы), 0-9 и - (дефис).

ARN -> (строка)

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

Created -> (булево)

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

Deleted -> (булево)

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

Endpoint -> (строка)

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

Endpoints -> (карта)

Карта, содержащая конечные точки домена Elasticsearch, используемые для отправки запросов индексации и поиска. Пример key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

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

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

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

Processing -> (булево)

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

UpgradeProcessing -> (булево)

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

ElasticsearchVersion -> (строка)

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

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

InstanceType -> (строка)

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

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

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

DedicatedMasterEnabled -> (булево)

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

ZoneAwarenessEnabled -> (булево)

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

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

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

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

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

DedicatedMasterType -> (строка)

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

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

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

WarmEnabled -> (булево)

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

WarmType -> (строка)

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

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

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

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

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

Enabled -> (булево)

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

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

EBSOptions для указанного домена. Дополнительную информацию см. в разделе Настройка хранилища на основе EBS.

EBSEnabled -> (булево)

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

VolumeType -> (строка)

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

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

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

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

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

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

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

AccessPolicies -> (строка)

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

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

Указывает состояние ежедневного автоматического резервного копирования SnapshotOptions

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

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

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

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

VPCId -> (строка)

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

SubnetIds -> (список)

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

(строка)

AvailabilityZones -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

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

Enabled -> (булево)

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

UserPoolId -> (строка)

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

IdentityPoolId -> (строка)

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

RoleArn -> (строка)

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

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

Указывает состояние EncryptionAtRestOptions.

Enabled -> (булево)

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

KmsKeyId -> (строка)

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

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

Указывает состояние NodeToNodeEncryptionOptions.

Enabled -> (булево)

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

AdvancedOptions -> (карта)

Указывает состояние AdvancedOptions

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

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

LogPublishingOptions -> (карта)

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

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

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

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

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

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

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

CloudWatchLogsLogGroupArn -> (строка)

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

Enabled -> (булево)

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

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

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

CurrentVersion -> (строка)

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

NewVersion -> (строка)

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

UpdateAvailable -> (булево)

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

Cancellable -> (булево)

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

UpdateStatus -> (строка)

Состояние обновления программного обеспечения службы. Это поле может принимать следующие значения: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED и NOT_ELIGIBLE .

Description -> (строка)

Описание UpdateStatus.

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

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

OptionalDeployment -> (булево)

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

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

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

EnforceHTTPS -> (булево)

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

TLSSecurityPolicy -> (строка)

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

Policy-Min-TLS-1-0-2019-07: Политика безопасности TLS, поддерживающая версии TLS 1.0 до TLS 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 до TLS 1.3 с шифрами с совершенной прямой секретностью

CustomEndpointEnabled -> (булево)

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

CustomEndpoint -> (строка)

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

CustomEndpointCertificateArn -> (строка)

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

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

Текущий статус расширенных параметров безопасности домена 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.

RolesKey -> (string)

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

SessionTimeoutMinutes -> (integer)

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

AnonymousAuthDisableDate -> (timestamp)

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

AnonymousAuthEnabled -> (boolean)

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

AutoTuneOptions -> (structure)

Текущий статус параметров автоматической настройки домена Elasticsearch.

State -> (string)

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

ErrorMessage -> (string)

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

ChangeProgressDetails -> (structure)

Указывает подробности изменений конфигурации домена.

ChangeId -> (string)

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

Message -> (string)

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

ConfigChangeStatus -> (string)

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

StartTime -> (timestamp)

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

LastUpdatedTime -> (timestamp)

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

InitiatedBy -> (string)

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

DomainProcessingStatus -> (string)

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

ModifyingProperties -> (list)

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

(structure)

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

Name -> (string)

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

ActiveValue -> (string)

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

PendingValue -> (string)

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

ValueType -> (string)

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

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