[ 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 -> (строка)
ARN -> (строка)
Created -> (логическое значение)
Deleted -> (логическое значение)
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 -> (логическое значение)
UpgradeProcessing -> (логическое значение)
EngineVersion -> (строка)
Elasticsearch_X.Y или OpenSearch_X.Y.ClusterConfig -> (структура)
Контейнер для конфигурации кластера домена.
InstanceType -> (строка)
InstanceCount -> (целое число)
DedicatedMasterEnabled -> (логическое значение)
ZoneAwarenessEnabled -> (логическое значение)
ZoneAwarenessConfig -> (структура)
Контейнер для параметров конфигурации зон доступности. Требуется только если ZoneAwarenessEnabled равно true.
AvailabilityZoneCount -> (целое число)
2 и 3. Если ваш домен развернут в VPC, это значение должно быть равно количеству подсетей.DedicatedMasterType -> (строка)
DedicatedMasterCount -> (целое число)
WarmEnabled -> (логическое значение)
WarmType -> (строка)
WarmCount -> (целое число)
ColdStorageOptions -> (структура)
Контейнер для параметров конфигурации холодного хранения.
Enabled -> (логическое значение)
MultiAZWithStandbyEnabled -> (логическое значение)
NodeOptions -> (список)
Список параметров узлов для домена.
(структура)
Настройки конфигурации для определения типа узла в кластере.
NodeType -> (строка)
NodeConfig -> (структура)
Параметры конфигурации для определения настройки любого типа узла.
Enabled -> (логическое значение)
Type -> (строка)
Count -> (целое число)
EBSOptions -> (структура)
Контейнер для настроек хранения на основе EBS для домена.
EBSEnabled -> (логическое значение)
VolumeType -> (строка)
VolumeSize -> (целое число)
Iops -> (целое число)
gp3 и предоставленных IOPS.Throughput -> (целое число)
gp3.AccessPolicies -> (строка)
IPAddressType -> (строка)
SnapshotOptions -> (структура)
УСТАНОВЛЕНО. Контейнер для параметров, необходимых для настройки автоматических снимков индексов домена.
AutomatedSnapshotStartHour -> (целое число)
0 часов.VPCOptions -> (структура)
Конфигурация VPC для домена.
VPCId -> (строка)
SubnetIds -> (список)
Список идентификаторов подсетей, связанных с VPC конечными точками для домена.
(строка)
AvailabilityZones -> (список)
Список зон доступности, связанных с подсетями VPC.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности, связанных с VPC конечными точками для домена.
(строка)
CognitoOptions -> (структура)
Пара ключи-значения для настройки аутентификации Amazon Cognito для OpenSearch Dashboards.
Enabled -> (логическое значение)
UserPoolId -> (строка)
IdentityPoolId -> (строка)
RoleArn -> (строка)
AmazonOpenSearchServiceCognitoAccess, которая позволяет OpenSearch Service настроить ваш пул пользователей и пул идентичностей.EncryptionAtRestOptions -> (структура)
Настройки шифрования при хранении данных для домена.
Enabled -> (логическое значение)
KmsKeyId -> (строка)
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.NodeToNodeEncryptionOptions -> (структура)
Включено или выключено шифрование между узлами.
Enabled -> (логическое значение)
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 -> (строка)
Enabled -> (логическое значение)
ServiceSoftwareOptions -> (структура)
Текущий статус программного обеспечения службы домена.
CurrentVersion -> (строка)
NewVersion -> (строка)
UpdateAvailable -> (булево)
Cancellable -> (булево)
UpdateStatus -> (строка)
Description -> (строка)
AutomatedUpdateDate -> (метка времени)
OptionalDeployment -> (булево)
DomainEndpointOptions -> (структура)
Дополнительные параметры для конечной точки домена, такие как требование HTTPS для всего трафика.
EnforceHTTPS -> (булево)
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 -> (строка)
CustomEndpointCertificateArn -> (строка)
AdvancedSecurityOptions -> (структура)
Настройки для тонкого управления доступом.
Enabled -> (булево)
InternalUserDatabaseEnabled -> (булево)
SAMLOptions -> (структура)
Контейнер для информации о конфигурации SAML для OpenSearch Dashboards.
Enabled -> (булево)
Idp -> (структура)
Описание информации поставщика идентификации SAML.
MetadataContent -> (строка)
EntityId -> (строка)
SubjectKey -> (строка)
RolesKey -> (строка)
SessionTimeoutMinutes -> (целое число)
JWTOptions -> (структура)
Контейнер с информацией о конфигурации JWT службы Amazon OpenSearch.
Enabled -> (булево)
SubjectKey -> (строка)
RolesKey -> (строка)
PublicKey -> (строка)
AnonymousAuthDisableDate -> (метка времени)
AnonymousAuthEnabled -> (булево)
IdentityCenterOptions -> (структура)
Параметры конфигурации для управления интеграцией IAM Identity Center в домене.
EnabledAPIAccess -> (булево)
IdentityCenterInstanceARN -> (строка)
SubjectKey -> (строка)
RolesKey -> (строка)
IdentityCenterApplicationARN -> (строка)
IdentityStoreId -> (строка)
AutoTuneOptions -> (структура)
Настройки автоматической настройки для домена.
State -> (строка)
ErrorMessage -> (строка)
UseOffPeakWindow -> (булево)
ChangeProgressDetails -> (структура)
Информация об изменениях конфигурации, происходящих в домене.
ChangeId -> (строка)
Message -> (строка)
ConfigChangeStatus -> (строка)
InitiatedBy -> (строка)
StartTime -> (метка времени)
LastUpdatedTime -> (метка времени)
OffPeakWindowOptions -> (структура)
Параметры, определяющие пользовательское 10-часовое окно, в течение которого OpenSearch Service может выполнять изменения конфигурации в домене.
Enabled -> (булево)
Включить ли окно вне пиковой нагрузки.
Этот параметр доступен только при изменении домена, созданного до 16 февраля 2023 года, а не при создании нового домена. Все домены, созданные после этой даты, имеют окно вне пиковой нагрузки по умолчанию. После включения окна вне пиковой нагрузки для домена его нельзя отключить.
OffPeakWindow -> (структура)
Настройки окна вне пиковой нагрузки для домена.
WindowStartTime -> (структура)
Пользовательское начальное время окна вне пиковой нагрузки в формате UTC. Длительность окна всегда составляет 10 часов, поэтому вы не можете указать конечное время. Например, если вы укажете 23:00 UTC в качестве начального времени, конечное время будет автоматически установлено на 9:00.
Hours -> (длинное целое число)
17 означает 17:00 UTC.Minutes -> (длинное целое число)
SoftwareUpdateOptions -> (структура)
Параметры обновления программного обеспечения службы для домена.
AutoSoftwareUpdateEnabled -> (булево)
DomainProcessingStatus -> (строка)
ModifyingProperties -> (список)
Информация о свойствах домена, которые в настоящее время изменяются.
(структура)
Информация о свойствах домена, которые в настоящее время изменяются.
Name -> (строка)
ActiveValue -> (строка)
PendingValue -> (строка)
ValueType -> (строка)
Тип значения, который в настоящее время изменяется. Свойства могут иметь два типа:
-
PLAIN_TEXT: Содержат прямые значения, такие как “1”, “True” или “c5.large.search”. -
STRINGIFIED_JSON: Содержат содержимое в формате JSON, например {“Enabled”:”True”}”.
AIMLOptions -> (структура)
Контейнер для параметров, необходимых для включения всех функций машинного обучения.
NaturalLanguageQueryGenerationOptions -> (структура)
Контейнер для параметров, необходимых для генерации запросов на естественном языке для указанного домена.
DesiredState -> (строка)
CurrentState -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.