Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

create-connector

Описание

Создает коннектор, который захватывает параметры подключения для протокола AS2 или SFTP. Для AS2 коннектор необходим для отправки файлов на внешне размещённый сервер AS2. Для SFTP коннектор необходим при отправке файлов на сервер SFTP или при получении файлов с сервера SFTP. Для получения дополнительной информации о коннекторах, см. Настройка коннекторов AS2 и Создание коннекторов SFTP .

Примечание

Вы должны указать ровно один объект конфигурации: либо для AS2 (As2Config ), либо для SFTP (SftpConfig ).

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

Синтаксис

  create-connector
--url <value>
[--as2-config <value>]
--access-role <value>
[--logging-role <value>]
[--tags <value>]
[--sftp-config <value>]
[--security-policy-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]

Параметры

--url (строка)

URL конечной точки AS2 или SFTP партнера.

--as2-config (структура)

Структура, содержащая параметры объекта соединителя AS2.

LocalProfileId -> (строка)

Уникальный идентификатор локального профиля AS2.

PartnerProfileId -> (строка)

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

MessageSubject -> (строка)

Используется в качестве атрибута HTTP-заголовка Subject в сообщениях AS2, отправляемых с помощью соединителя.

Compression -> (строка)

Указывает, сжата ли AS2-файла.

EncryptionAlgorithm -> (строка)

Алгоритм, используемый для шифрования файла.

Обратите внимание на следующее:

  • Не используйте алгоритм DES_EDE3_CBC, если это не необходимо для поддержки устаревшего клиента, требующего его, так как это слабый алгоритм шифрования.
  • Вы можете указать только NONE, если URL вашего соединителя использует HTTPS. Использование HTTPS гарантирует, что трафик не отправляется в открытом виде.

SigningAlgorithm -> (строка)

Алгоритм, используемый для подписи AS2-сообщений, отправляемых с помощью соединителя.

MdnSigningAlgorithm -> (строка)

Алгоритм подписи ответа MDN.

Примечание

Если установлено значение DEFAULT (или вообще не указано), используется значение для SigningAlgorithm.

MdnResponse -> (строка)

Используется для исходящих запросов (от соединителя Transfer Family к партнёрскому серверу AS2) для определения, является ли ответ партнёра на передачи синхронным или асинхронным. Укажите одно из следующих значений:

  • SYNC: Система ожидает синхронный ответ MDN, подтверждающий успешную (или неуспешную) передачу файла.
  • NONE: Указывает, что ответ MDN не требуется.

BasicAuthSecretId -> (строка)

Обеспечивает поддержку аутентификации Basic для API соединителей AS2. Для использования аутентификации Basic необходимо предоставить имя или Amazon Resource Name (ARN) секрета в Secrets Manager.

Значение по умолчанию для этого параметра — null, что означает, что аутентификация Basic для соединителя не включена.

Если соединитель должен использовать аутентификацию Basic, секрет должен иметь следующий формат:

{ "Username": "user-name", "Password": "user-password" }

Замените user-name и user-password на учетные данные фактического пользователя, который проходит аутентификацию.

Обратите внимание на следующее:

  • Эти учетные данные хранятся в Secrets Manager, а не передаются напрямую в этот API.
  • Если вы используете API, SDK или CloudFormation для настройки соединителя, то необходимо создать секрет, прежде чем включить аутентификацию Basic. Однако, если вы используете консоль управления Amazon Web Services, система может создать секрет за вас.

Если вы ранее включили аутентификацию Basic для соединителя, вы можете отключить её с помощью вызова API UpdateConnector. Например, если вы используете командную строку, можно выполнить следующую команду, чтобы удалить аутентификацию Basic:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

PreserveContentType -> (строка)

Позволяет использовать Amazon S3 Content-Type, связанную с объектами в S3, вместо того, чтобы тип содержимого отображался на основе расширения файла. Этот параметр по умолчанию включён при создании соединителя AS2 через консоль, но по умолчанию выключен при создании соединителя AS2 путём непосредственного вызова API.

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

LocalProfileId=string,PartnerProfileId=string,MessageSubject=string,Compression=string,EncryptionAlgorithm=string,SigningAlgorithm=string,MdnSigningAlgorithm=string,MdnResponse=string,BasicAuthSecretId=string,PreserveContentType=string

Синтаксис JSON:

{
  "LocalProfileId": "string",
  "PartnerProfileId": "string",
  "MessageSubject": "string",
  "Compression": "ZLIB"|"DISABLED",
  "EncryptionAlgorithm": "AES128_CBC"|"AES192_CBC"|"AES256_CBC"|"DES_EDE3_CBC"|"NONE",
  "SigningAlgorithm": "SHA256"|"SHA384"|"SHA512"|"SHA1"|"NONE",
  "MdnSigningAlgorithm": "SHA256"|"SHA384"|"SHA512"|"SHA1"|"NONE"|"DEFAULT",
  "MdnResponse": "SYNC"|"NONE",
  "BasicAuthSecretId": "string",
  "PreserveContentType": "ENABLED"|"DISABLED"
}

--access-role (строка)

Соединители используются для отправки файлов с помощью протоколов AS2 или SFTP. Для роли доступа предоставьте Amazon Resource Name (ARN) роли управления идентификацией и доступом для использования.

Для соединителей AS2

С помощью AS2 вы можете отправлять файлы, вызвав StartFileTransfer и указав пути к файлам в параметре запроса SendFilePaths. Мы используем родительский каталог файла (например, для --send-file-paths /bucket/dir/file.txt родительский каталог — /bucket/dir/) для временного хранения обработанного AS2-файла сообщения, хранения MDN при получении их от партнёра и записи итогового JSON-файла, содержащего соответствующие метаданные передачи. Таким образом, роль AccessRole должна предоставлять чтение и запись в родительский каталог расположения файла, используемого в запросе StartFileTransfer. Кроме того, необходимо предоставить чтение и запись в родительский каталог файлов, которые вы намерены отправлять с помощью StartFileTransfer.

Если вы используете аутентификацию Basic для своего соединителя AS2, роли доступа требуется разрешение secretsmanager:GetSecretValue для секрета. Если секрет зашифрован с помощью управляемого клиентом ключа вместо ключа, управляемого Amazon Web Services в Secrets Manager, то роль также должна иметь разрешение kms:Decrypt для этого ключа.

Для соединителей SFTP

Убедитесь, что роль доступа предоставляет чтение и запись в родительский каталог расположения файла, используемого в запросе StartFileTransfer. Кроме того, убедитесь, что роль предоставляет разрешение secretsmanager:GetSecretValue на Secrets Manager.

--logging-role (строка)

Amazon Resource Name (ARN) роли управления идентификацией и доступом (IAM), которая позволяет соединителю включать протоколирование CloudWatch для событий Amazon S3. При установке вы можете просматривать активность соединителя в своих журналах CloudWatch.

--tags (список)

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

(структура)

Создаёт ключевую пару для конкретного ресурса. Теги — это метаданные, которые можно использовать для поиска и группирования ресурсов для различных целей. Вы можете применять теги к серверам, пользователям и ролям. Ключ тега может принимать несколько значений. Например, чтобы сгруппировать серверы для целей бухгалтерского учёта, можно создать тег под названием Group и назначить значения Research и Accounting для этой группы.

Key -> (строка)

Имя, назначенное тегу, который вы создаёте.

Value -> (строка)

Содержит одно или несколько значений, которые вы назначили имени ключа, который создали.

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

Key=string,Value=string ...

Синтаксис JSON:

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

--sftp-config (структура)

Структура, содержащая параметры объекта соединителя SFTP.

UserSecretId -> (строка)

Идентификатор секрета (в Amazon Web Services Secrets Manager), содержащего закрытый ключ пользователя SFTP, пароль или оба. Идентификатор должен быть Amazon Resource Name (ARN) секрета.

Примечание

  • Необходим при создании соединителя SFTP
  • Необязателен при обновлении существующего соединителя SFTP

TrustedHostKeys -> (список)

Общедоступная часть ключа хоста или ключей, используемых для идентификации внешнего сервера, к которому вы подключаетесь. Для получения необходимых ключей можно использовать команду ssh-keyscan на сервере SFTP.

Примечание

TrustedHostKeys необязательно для CreateConnector. Если не указано, можно использовать TestConnection для получения ключа серверного хоста во время первой попытки подключения и затем обновить соединитель с полученным ключом хоста.

Три стандартных элемента формата общедоступного ключа SSH — <key type> , <body base64> и необязательный <comment>, разделённые пробелами. Укажите только <key type> и <body base64>: не вводите часть ключа <comment>.

Для проверенных ключей хоста Transfer Family принимает ключи RSA и ECDSA.

  • Для ключей RSA строка <key type> равна ssh-rsa.
  • Для ключей ECDSA строка <key type> равна либо ecdsa-sha2-nistp256, либо ecdsa-sha2-nistp384, либо ecdsa-sha2-nistp521, в зависимости от размера сгенерированного ключа.

Выполните эту команду, чтобы получить ключ хоста сервера SFTP, где имя вашего сервера SFTP — ftp.host.com.

ssh-keyscan ftp.host.com

Это выводит общедоступный ключ хоста в стандартный вывод.

ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key

Скопируйте и вставьте эту строку в поле TrustedHostKeys для команды create-connector или в поле Проверенные ключи хоста в консоли.

(строка)

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

Укажите количество одновременных подключений, которые ваш соединитель создаёт к удалённому серверу. Значение по умолчанию — 5 (это также максимальное разрешённое значение).

Этот параметр определяет количество активных подключений, которые ваш соединитель может установить с удалённым сервером одновременно. Увеличение этого значения может повысить производительность соединителя при передаче больших партий файлов, позволяя выполнять операции параллельно.

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

UserSecretId=string,TrustedHostKeys=string,string,MaxConcurrentConnections=integer

Синтаксис JSON:

{
  "UserSecretId": "string",
  "TrustedHostKeys": ["string", ...],
  "MaxConcurrentConnections": integer
}

--security-policy-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 (boolean)

Включить отладку логгирования.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

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

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер cli для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

ConnectorId -> (string)

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

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

Spec-Zone.ru

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