Spec-Zone.ru › AWS CLI v2

[ aws . opensearchserverless ]

создать-конфигурацию-безопасности

Описание

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

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

Синтаксис

  create-security-config
--type <value>
--name <value>
[--description <value>]
[--saml-options <value>]
[--iam-identity-center-options <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]

Параметры

--type (строка)

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

Возможные значения:

  • saml
  • iamidentitycenter

--name (строка)

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

--description (строка)

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

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

Описывает параметры SAML в виде набора ключ-значение. Это поле обязательно, если вы указали saml для параметра type.

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

Описывает параметры IAM Identity Center в виде набора ключ-значение. Это поле обязательно, если вы указали iamidentitycenter для параметра type.

instanceArn -> (строка)

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

userAttribute -> (строка)

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

groupAttribute -> (строка)

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

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

instanceArn=string,userAttribute=string,groupAttribute=string

Синтаксис JSON:

{
  "instanceArn": "string",
  "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 для вывода.

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