Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

Удалить домен

Описание

Удаляет домен Amazon OpenSearch Service и все его данные. После удаления домена восстановить его невозможно.

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

Синтаксис

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

Имя домена, который требуется удалить.

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

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

DomainId -> (строка)

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

DomainName -> (строка)

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

ARN -> (строка)

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

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

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

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

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

Endpoint -> (строка)

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

EndpointV2 -> (строка)

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

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

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

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

key -> (строка)

value -> (строка)

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

DomainEndpointV2HostedZoneId -> (строка)

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

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

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

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

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

EngineVersion -> (строка)

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

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

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

InstanceType -> (строка)

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

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

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

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

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

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

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

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

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

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

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

DedicatedMasterType -> (строка)

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

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

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

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

Включить или выключить тёплый кэш для кластера.

WarmType -> (строка)

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

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

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

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

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

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

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

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

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

NodeOptions -> (список)

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

(структура)

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

NodeType -> (строка)

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

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

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

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

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

Type -> (строка)

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

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

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

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

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

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

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

VolumeType -> (строка)

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

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

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

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

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

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

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

AccessPolicies -> (строка)

Документ политики управления доступом IAM, определяющий политики доступа к домену.

IPAddressType -> (строка)

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

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

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

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

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

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

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

VPCId -> (строка)

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

SubnetIds -> (список)

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

(строка)

AvailabilityZones -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

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

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

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

UserPoolId -> (строка)

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

IdentityPoolId -> (строка)

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

RoleArn -> (строка)

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

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

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

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

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

KmsKeyId -> (строка)

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

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

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

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

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

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

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

key -> (строка)

value -> (строка)

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

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

key -> (строка)

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

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

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

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

Примечание

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

CloudWatchLogsLogGroupArn -> (строка)

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

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

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

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

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

CurrentVersion -> (строка)

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

NewVersion -> (строка)

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

UpdateAvailable -> (булево)

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

Cancellable -> (булево)

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

UpdateStatus -> (строка)

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

Description -> (строка)

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

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

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

OptionalDeployment -> (булево)

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

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

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

EnforceHTTPS -> (булево)

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

TLSSecurityPolicy -> (строка)

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

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

CustomEndpointEnabled -> (булево)

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

CustomEndpoint -> (строка)

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

CustomEndpointCertificateArn -> (строка)

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

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

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

Enabled -> (булево)

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

InternalUserDatabaseEnabled -> (булево)

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

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

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

Enabled -> (булево)

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

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

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

MetadataContent -> (строка)

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

EntityId -> (строка)

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

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

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

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

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

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

Enabled -> (булево)

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

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

PublicKey -> (строка)

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

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

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

AnonymousAuthEnabled -> (булево)

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

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

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

EnabledAPIAccess -> (булево)

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

IdentityCenterInstanceARN -> (строка)

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

SubjectKey -> (строка)

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

RolesKey -> (строка)

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

IdentityCenterApplicationARN -> (строка)

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

IdentityStoreId -> (строка)

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

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

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

State -> (строка)

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

ErrorMessage -> (строка)

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

UseOffPeakWindow -> (булево)

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

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

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

ChangeId -> (строка)

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

Message -> (строка)

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

ConfigChangeStatus -> (строка)

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

InitiatedBy -> (строка)

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

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

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

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

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

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

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

Enabled -> (булево)

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

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

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

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

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

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

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

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

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

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

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

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

AutoSoftwareUpdateEnabled -> (булево)

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

DomainProcessingStatus -> (строка)

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

ModifyingProperties -> (список)

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

(структура)

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

Name -> (строка)

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

ActiveValue -> (строка)

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

PendingValue -> (строка)

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

ValueType -> (строка)

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

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

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

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

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

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

DesiredState -> (строка)

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

CurrentState -> (строка)

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

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

Spec-Zone.ru

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