Spec-Zone.ru › AWS CLI v2

[ aws . es ]

удаление-домена-elasticsearch

Описание

Постоянно удаляет указанный домен Elasticsearch и все его данные. После удаления домена его восстановить нельзя.

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

Синтаксис

  delete-elasticsearch-domain
--domain-name <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, который вы хотите навсегда удалить.

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

Вывод

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

Идентификатор 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 до 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 -> (булево)

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

CustomEndpoint -> (строка)

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

CustomEndpointCertificateArn -> (строка)

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

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

Текущий статус расширенных параметров безопасности домена Elasticsearch.

Enabled -> (boolean)

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

InternalUserDatabaseEnabled -> (boolean)

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

SAMLOptions -> (structure)

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

Enabled -> (boolean)

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

Idp -> (structure)

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

MetadataContent -> (string)

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

EntityId -> (string)

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

SubjectKey -> (string)

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

RolesKey -> (string)

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

SessionTimeoutMinutes -> (integer)

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

AnonymousAuthDisableDate -> (timestamp)

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

AnonymousAuthEnabled -> (boolean)

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

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API