Spec-Zone.ru › AWS CLI v2

[ aws . mailmanager ]

create-relay

Описание

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

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

Синтаксис

  create-relay
--authentication <value>
[--client-token <value>]
--relay-name <value>
--server-name <value>
--server-port <value>
[--tags <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]

Параметры

--authentication (структура помеченного объединения)

Аутентификация для сервера назначения реле — укажите secretARN, где хранятся SMTP-креденциалы.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: NoAuthentication, SecretArn.

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

Оставьте пустую структуру, если сервер назначения реле не требует аутентификации SMTP-креденциалов.

SecretArn -> (строка)

ARN секрета, созданного в secrets manager, где хранятся SMTP-креденциалы сервера реле.

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

NoAuthentication={},SecretArn=string

Синтаксис JSON:

{
  "NoAuthentication": {

  },
  "SecretArn": "string"
}

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

Уникальный маркер, который Amazon SES использует для распознавания последующих повторных попыток обработки одного и того же запроса.

--relay-name (строка)

Уникальное имя ресурса реле.

--server-name (строка)

Адрес сервера назначения реле.

--server-port (целое число)

Порт сервера назначения реле.

--tags (список)

Теги, используемые для организации, отслеживания или управления доступом к ресурсу. Например, { “теги”: {“ключ1”:”значение1”, “ключ2”:”значение2”} }.

(структура)

Пара ключ-значение (значение необязательно), которую вы можете определить и назначить ресурсам Amazon Web Services.

Ключ -> (строка)

Ключ тега ключ-значение.

Значение -> (строка)

Значение тега ключ-значение.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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-адрес команды на указанный.

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

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

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

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

--output (строка)

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

  • json
  • text
  • таблица
  • 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.

Вывод

RelayId -> (строка)

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

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

Spec-Zone.ru

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