describe-connector

Описание

Описывает коннектор, идентифицируемый по ConnectorId.

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

Синтаксис

  describe-connector
--connector-id <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 (строка)

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

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

Вывод

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

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

Arn -> (строка)

Уникальное имя Amazon Resource Name (ARN) для соединителя.

ConnectorId -> (строка)

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

Url -> (строка)

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

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

Структура, содержащая параметры для объекта соединителя 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 Connectors. Для использования аутентификации 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.

AccessRole -> (строка)

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

Для соединителей 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.

LoggingRole -> (строка)

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

Tags -> (список)

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

(структура)

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

Key -> (строка)

Имя, присвоенное созданному вами тегу.

Value -> (строка)

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

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

Структура, содержащая параметры для объекта соединителя 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 (это также максимальное разрешённое значение).

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

ServiceManagedEgressIpAddresses -> (список)

Список адресов внешних IP-подключений этого соединителя. Эти IP-адреса назначаются автоматически при создании соединителя.

(строка)

SecurityPolicyName -> (строка)

Текстовое имя политики безопасности для указанного соединителя.