Spec-Zone.ru › AWS CLI v2

[ aws . opensearchserverless ]

обновить-настройки-безопасности

Описание

Обновляет конфигурацию безопасности для OpenSearch Serverless. Дополнительную информацию см. в разделе SAML-аутентификация для Amazon OpenSearch Serverless.

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

Синтаксис

  update-security-config
--id <value>
--config-version <value>
[--description <value>]
[--saml-options <value>]
[--iam-identity-center-options-updates <value>]
[--client-token <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]

Параметры

--id (строка)

Идентификатор конфигурации безопасности. Для SAML идентификатор будет saml/<accountId>/<idpProviderName> . Например, saml/123456789123/OKTADev .

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

Версия конфигурации безопасности для обновления. Последнюю версию конфигурации безопасности можно найти, используя команду GetSecurityPolicy.

--description (строка)

Описание конфигурации безопасности.

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

Параметры SAML в виде карты ключ-значение.

metadata -> (строка)

Файл XML-метаданных IdP, сгенерированный вашим поставщиком удостоверений.

userAttribute -> (строка)

Атрибут пользователя для этой интеграции SAML.

groupAttribute -> (строка)

Атрибут группы для этой интеграции SAML.

openSearchServerlessEntityId -> (строка)

Пользовательский атрибут идентификатора сущности для переопределения стандартного идентификатора сущности для этой интеграции SAML.

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

Тайм-аут сеанса в минутах. По умолчанию 60 минут (12 часов).

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

metadata=string,userAttribute=string,groupAttribute=string,openSearchServerlessEntityId=string,sessionTimeout=integer

Синтаксис JSON:

{
  "metadata": "string",
  "userAttribute": "string",
  "groupAttribute": "string",
  "openSearchServerlessEntityId": "string",
  "sessionTimeout": integer
}

--iam-identity-center-options-updates (структура)

Описывает параметры IAM Identity Center в виде карты ключ-значение.

userAttribute -> (строка)

Атрибут пользователя для этой интеграции IAM Identity Center. По умолчанию UserId .

groupAttribute -> (строка)

Атрибут группы для этой интеграции IAM Identity Center. По умолчанию GroupId .

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

userAttribute=string,groupAttribute=string

Синтаксис JSON:

{
  "userAttribute": "UserId"|"UserName"|"Email",
  "groupAttribute": "GroupId"|"GroupName"
}

--client-token (строка)

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

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет принята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример JSON ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный каркас JSON нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (булево)

Включить отладочную регистрацию.

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

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

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

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

id -> (строка)

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

type -> (строка)

Тип конфигурации безопасности.

configVersion -> (строка)

Версия конфигурации безопасности.

description -> (строка)

Описание конфигурации безопасности.

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

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

metadata -> (строка)

Файл XML-метаданных IdP, сгенерированный вашим поставщиком удостоверений.

userAttribute -> (строка)

Атрибут пользователя для этой интеграции SAML.

groupAttribute -> (строка)

Атрибут группы для этой интеграции SAML.

openSearchServerlessEntityId -> (строка)

Пользовательский атрибут идентификатора сущности для переопределения стандартного идентификатора сущности для этой интеграции SAML.

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

Тайм-аут сеанса в минутах. По умолчанию 60 минут (12 часов).

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

Описывает параметры IAM Identity Center в виде карты ключ-значение.

instanceArn -> (строка)

ARN экземпляра IAM Identity Center, используемого для интеграции с OpenSearch Serverless.

applicationArn -> (строка)

ARN приложения IAM Identity Center, используемого для интеграции с OpenSearch Serverless.

applicationName -> (строка)

Имя приложения IAM Identity Center, используемого для интеграции с OpenSearch Serverless.

applicationDescription -> (строка)

Описание приложения IAM Identity Center, используемого для интеграции с OpenSearch Serverless.

userAttribute -> (строка)

Атрибут пользователя для этой интеграции IAM Identity Center. По умолчанию UserId

groupAttribute -> (строка)

Атрибут группы для этой интеграции IAM Identity Center. По умолчанию GroupId .

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

Дата создания конфигурации.

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

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

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

Spec-Zone.ru

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