обновить-коннектор
Описание
Обновляет некоторые параметры существующего коннектора. Укажите ConnectorId для коннектора, который вы хотите обновить, вместе с новыми значениями параметров для обновления.
См. также: Документацию API AWS
Синтаксис
update-connector
--connector-id <value>
[--url <value>]
[--as2-config <value>]
[--access-role <value>]
[--logging-role <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]
Параметры
--connector-id (строка)
--url (строка)
--as2-config (структура)
Структура, содержащая параметры объекта коннектора AS2.
LocalProfileId -> (строка)
PartnerProfileId -> (строка)
MessageSubject -> (строка)
Subject в сообщениях AS2, отправляемых с помощью коннектора.Compression -> (строка)
EncryptionAlgorithm -> (строка)
Алгоритм, используемый для шифрования файла.
Обратите внимание на следующее:
- Не используйте алгоритм
DES_EDE3_CBC, если это не необходимо для поддержки устаревшего клиента, требующего его, так как это слабый алгоритм шифрования. - Вы можете указать только
NONE, если URL вашего коннектора использует HTTPS. Использование HTTPS гарантирует, что никакой трафик не отправляется в открытом виде.
SigningAlgorithm -> (строка)
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 -> (строка)
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) роли управления идентификацией и доступом (IAM), которую следует использовать.
С помощью 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 для этого ключа.
Убедитесь, что роль доступа предоставляет чтение и запись в родительский каталог расположения файла, используемого в запросе StartFileTransfer. Кроме того, убедитесь, что роль предоставляет разрешение secretsmanager:GetSecretValue для Secrets Manager.
--logging-role (строка)
--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)
© Copyright 2025, Amazon Web Services. Created using Sphinx.