describe-server

Описание

Описывает сервер, поддерживающий протокол передачи файлов, который вы указываете, передавая параметр ServerId.

Ответ содержит описание свойств сервера. Когда вы зададите EndpointType в значение VPC, ответ будет содержать EndpointDetails.

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

Синтаксис

  describe-server
--server-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]

Параметры

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

Вывод

Сервер -> (структура)

Массив, содержащий свойства сервера с указанными вами ServerID.

Arn -> (строка)

Указывает уникальное имя Amazon Resource Name (ARN) сервера.

Сертификат -> (строка)

Указывает ARN сертификата Amazon Web Services Certificate Manager (ACM). Требуется, когда Protocols установлено в FTPS.

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

Настройки протокола, настроенные для вашего сервера.

Для указания пассивного режима (для протоколов FTP и FTPS) используйте параметр PassiveIp. Введите единственный адрес IPv4 с точкой, например, внешний IP-адрес брандмауэра, маршрутизатора или балансировщика нагрузки.
Чтобы пропустить ошибку, возникающую при попытке клиента использовать команду SETSTAT при загрузке файла в Amazon S3-хранилище, используйте параметр SetStatOption. Чтобы сервер Transfer Family игнорировал команду SETSTAT и загружал файлы без необходимости внесения изменений в ваш SFTP-клиент, установите значение в ENABLE_NO_OP. Если вы установите параметр SetStatOption в ENABLE_NO_OP, Transfer Family генерирует запись в журналы Amazon CloudWatch Logs, чтобы вы могли определить, когда клиент выполняет вызов SETSTAT.
Чтобы определить, возобновляет ли ваш сервер Transfer Family недавние, согласованные сеансы через уникальный идентификатор сеанса, используйте параметр TlsSessionResumptionMode.
As2Transports указывает метод передачи для сообщений AS2. В настоящее время поддерживается только HTTP.

PassiveIp -> (строка)

Указывает пассивный режим для протоколов FTP и FTPS. Введите один IP-адрес IPv4, например, общедоступный IP-адрес брандмауэра, маршрутизатора или балансировщика нагрузки. Например:

aws transfer update-server --protocol-details PassiveIp=0.0.0.0

Замените 0.0.0.0 в примере выше на фактический IP-адрес, который вы хотите использовать.

Примечание

Если вы измените значение PassiveIp, вы должны остановить и перезапустить свой сервер Transfer Family, чтобы изменения вступили в силу. Подробнее о применении пассивного режима (PASV) в среде NAT см. в разделе Настройка вашего FTPS-сервера за брандмауэром или NAT с Transfer Family.

Специальные значения

AUTO и 0.0.0.0 — это специальные значения для параметра PassiveIp. Значение PassiveIp=AUTO по умолчанию присваивается серверам типа FTP и FTPS. В этом случае сервер автоматически отвечает одним из конечных IP-адресов в ответе PASV. PassiveIp=0.0.0.0 имеет более уникальное применение в использовании. Например, если у вас есть среда High Availability (HA) Network Load Balancer (NLB), в которой у вас есть 3 подсети, вы можете указать только один IP-адрес с помощью параметра PassiveIp. Это снижает эффективность использования High Availability. В этом случае вы можете указать PassiveIp=0.0.0.0. Это сообщает клиенту использовать тот же IP-адрес, что и соединение управления, и использовать все AZ для своих соединений. Однако обратите внимание, что не все FTP-клиенты поддерживают ответ PassiveIp=0.0.0.0. FileZilla и WinSCP поддерживают его. Если вы используете другие клиенты, проверьте, поддерживает ли ваш клиент ответ PassiveIp=0.0.0.0.

TlsSessionResumptionMode -> (строка)

Свойство, используемое с серверами Transfer Family, использующими протокол FTPS. Возобновление сеанса TLS обеспечивает механизм возобновления или совместного использования согласованного секретного ключа между соединением управления и данными для сеанса FTPS. TlsSessionResumptionMode определяет, возобновляет ли сервер недавние, согласованные сеансы через уникальный идентификатор сеанса. Это свойство доступно во время вызовов CreateServer и UpdateServer. Если значение TlsSessionResumptionMode не указано во время CreateServer, оно по умолчанию устанавливается в ENFORCED.

DISABLED: сервер не обрабатывает запросы клиентов на возобновление сеанса TLS и создает новый сеанс TLS для каждого запроса.
ENABLED: сервер обрабатывает и принимает клиентов, выполняющих возобновление сеанса TLS. Сервер не отклоняет подключения клиентов к данным, которые не выполняют обработку запросов клиента на возобновление сеанса TLS.
ENFORCED: сервер обрабатывает и принимает клиентов, выполняющих возобновление сеанса TLS. Сервер отклоняет подключения клиентов к данным, которые не выполняют обработку запросов клиента на возобновление сеанса TLS. Перед установкой значения ENFORCED протестируйте свои клиенты.

Примечание

Не все клиенты FTPS выполняют возобновление сеанса TLS. Поэтому, если вы выберете принудительное возобновление сеанса TLS, вы предотвратите подключение клиентов FTPS, которые не выполняют переговоры по протоколу. Чтобы определить, можете ли вы использовать значение ENFORCED, вам нужно протестировать своих клиентов.

SetStatOption -> (строка)

Используйте SetStatOption, чтобы пропустить ошибку, которая возникает, когда клиент пытается использовать SETSTAT для файла, который вы загружаете в хранилище S3.

Некоторые SFTP-клиенты для передачи файлов могут пытаться изменить атрибуты удаленных файлов, включая отметки времени и разрешения, с помощью команд, таких как SETSTAT при загрузке файла. Однако эти команды несовместимы с системами объектного хранения, такими как Amazon S3.

Установите значение в ENABLE_NO_OP, чтобы сервер Transfer Family игнорировал команду SETSTAT и загружал файлы без необходимости внесения изменений в ваш SFTP-клиент. Хотя настройка SetStatOption ENABLE_NO_OP игнорирует ошибку, она генерирует запись в журналы Amazon CloudWatch Logs, чтобы вы могли определить, когда клиент выполняет вызов SETSTAT.

Примечание

Если вы хотите сохранить исходное отметки времени файла и изменить другие атрибуты файла с помощью SETSTAT, вы можете использовать Amazon EFS в качестве хранилища с Transfer Family.

As2Transports -> (список)

Указывает метод передачи для сообщений AS2. В настоящее время поддерживается только HTTP.

(строка)

Домен -> (строка)

Указывает домен системы хранения, используемой для передачи файлов. Доступны два домена: Amazon Simple Storage Service (Amazon S3) и Amazon Elastic File System (Amazon EFS). Значение по умолчанию — S3.

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

Настройки виртуального частного облака (VPC) для вашего сервера. Если вы разместите свой конечную точку внутри VPC, вы можете сделать ее доступной только для ресурсов внутри VPC, или вы можете подключить IP-адреса Elastic и сделать свою конечную точку доступной клиентам через интернет. Стандартные группы безопасности VPC автоматически назначаются вашей конечной точке.

AddressAllocationIds -> (список)

Список идентификаторов выделения адресов, необходимых для подключения IP-адреса Elastic к конечной точке вашего сервера.

Идентификатор выделения адреса соответствует идентификатору выделения IP-адреса Elastic. Это значение можно получить из поля allocationId из типа данных Amazon EC2 Address. Один из способов получить это значение — вызов API EC2 DescribeAddresses.

Этот параметр необязателен. Установите этот параметр, если хотите сделать конечную точку VPC доступной извне. Подробности см. в разделе Создание конечной точки с доступом к интернету для вашего сервера.

Примечание

Это свойство можно установить только следующим образом:

EndpointType должно быть установлено в VPC
Сервер Transfer Family должен быть выключен.
Вы не можете установить этот параметр для серверов Transfer Family, использующих протокол FTP.
На сервере уже должны быть заполнены SubnetIds (SubnetIds и AddressAllocationIds не могут быть обновлены одновременно).
AddressAllocationIds не может содержать дубликатов и должен иметь длину, равную SubnetIds. Например, если у вас есть три идентификатора подсети, вы должны также указать три идентификатора выделения адресов.
Вызовите API UpdateServer, чтобы установить или изменить этот параметр.

(строка)

SubnetIds -> (список)

Список идентификаторов подсетей, необходимых для размещения конечной точки вашего сервера в VPC.

Примечание

Это свойство можно установить только при EndpointType установлено в VPC.

(строка)

VpcEndpointId -> (строка)

Идентификатор конечной точки VPC.

Примечание

Это свойство можно установить только при EndpointType установлено в VPC_ENDPOINT.

Дополнительную информацию см. на странице https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

VpcId -> (строка)

Идентификатор VPC, в котором будет размещена конечная точка сервера.

Примечание

Это свойство можно установить только при EndpointType установлено в VPC.

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности, которые доступны для подключения к конечной точке вашего сервера.

Примечание

Это свойство можно установить только при EndpointType установлено в VPC.

Вы можете изменить свойство SecurityGroupIds в API UpdateServer только при изменении EndpointType со значения PUBLIC или VPC_ENDPOINT на VPC. Чтобы изменить группы безопасности, связанные с конечной точкой VPC сервера после создания, используйте API Amazon EC2 ModifyVpcEndpoint.

(строка)

EndpointType -> (строка)

Определяет тип конечной точки, к которой подключен ваш сервер. Если ваш сервер подключен к конечной точке VPC, он недоступен через общедоступный интернет.

HostKeyFingerprint -> (строка)

Указывает Base64-кодированную отпечатку SHA256 ключа хоста сервера. Это значение эквивалентно результату команды ssh-keygen -l -f my-new-server-key.

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

Указывает информацию для вызова API аутентификации, предоставленной клиентом. Это поле не заполняется, когда состояние сервера является AWS_DIRECTORY_SERVICE или SERVICE_MANAGED.

Url -> (string)

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

InvocationRole -> (string)

Этот параметр применим только в том случае, если ваш IdentityProviderType является API_GATEWAY. Указывает тип InvocationRole, используемого для аутентификации учетной записи пользователя.

DirectoryId -> (string)

Идентификатор каталога службы каталогов Directory Service, который вы хотите использовать в качестве поставщика удостоверений.

Function -> (string)

ARN функции Lambda, которую нужно использовать для поставщика удостоверений.

SftpAuthenticationMethods -> (string)

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

PASSWORD - пользователям необходимо ввести свой пароль для подключения.
PUBLIC_KEY - пользователям необходимо предоставить свой закрытый ключ для подключения.
PUBLIC_KEY_OR_PASSWORD - пользователи могут аутентифицироваться с помощью пароля или ключа. Это значение по умолчанию.
PUBLIC_KEY_AND_PASSWORD - пользователям необходимо предоставить как закрытый ключ, так и пароль для подключения. Сервер проверяет ключ в первую очередь, и если ключ действителен, система запрашивает пароль. Если предоставленный закрытый ключ не соответствует сохраненному открытому ключу, аутентификация завершается неудачно.

IdentityProviderType -> (string)

Режим аутентификации для сервера. Значение по умолчанию - SERVICE_MANAGED, которое позволяет хранить и получать учетные данные пользователей в службе Transfer Family.

Используйте AWS_DIRECTORY_SERVICE, чтобы предоставить доступ к группам Active Directory в службе каталогов Directory Service для Microsoft Active Directory или Microsoft Active Directory в вашей локальной среде или в Amazon Web Services с помощью AD Connector. Этот вариант также требует указать идентификатор каталога, используя параметр IdentityProviderDetails.

Используйте значение API_GATEWAY, чтобы интегрироваться с выбранным вами поставщиком удостоверений. Настройка API_GATEWAY требует предоставить URL-адрес конечной точки Amazon API Gateway, к которому нужно обратиться для аутентификации, используя параметр IdentityProviderDetails.

Используйте значение AWS_LAMBDA, чтобы напрямую использовать функцию Lambda в качестве поставщика удостоверений. Если вы выберете это значение, вы должны указать ARN функции Lambda в параметре Function для типа данных IdentityProviderDetails.

LoggingRole -> (string)

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

PostAuthenticationLoginBanner -> (string)

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

Примечание

Протокол SFTP не поддерживает баннеры отображения после аутентификации.

PreAuthenticationLoginBanner -> (string)

Указывает строку, отображаемую при подключении пользователей к серверу. Эта строка отображается до аутентификации пользователя. Например, следующий баннер отображает сведения о использовании системы:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

Protocols -> (list)

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

SFTP (Secure Shell (SSH) File Transfer Protocol): Передача файлов по SSH
FTPS (File Transfer Protocol Secure): Передача файлов с шифрованием TLS
FTP (File Transfer Protocol): Незашифрованная передача файлов
AS2 (Applicability Statement 2): используется для переноса структурированных данных B2B

Примечание

Если вы выбираете FTPS, вы должны выбрать сертификат, хранящийся в Certificate Manager (ACM), который используется для идентификации вашего сервера, когда клиенты подключаются к нему через FTPS.
Если Protocol включает либо FTP, либо FTPS, то EndpointType должно быть VPC, а IdentityProviderType должно быть либо AWS_DIRECTORY_SERVICE, либо AWS_LAMBDA, либо API_GATEWAY.
Если Protocol включает FTP, то AddressAllocationIds не может быть ассоциирован.
Если Protocol установлено только на SFTP, то EndpointType может быть установлено на PUBLIC, а IdentityProviderType может быть установлено на любой из поддерживаемых типов удостоверений: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA или API_GATEWAY.
Если Protocol включает AS2, то EndpointType должно быть VPC, а домен должен быть Amazon S3.

(string)

SecurityPolicyName -> (string)

Указывает имя политики безопасности для сервера.

ServerId -> (string)

Указывает уникальный идентификатор, присвоенный системой, для сервера, который вы инициализировали.

State -> (string)

Состояние описанного сервера. Значение ONLINE указывает, что сервер может принимать задачи и передавать файлы. Значение State, равное OFFLINE, означает, что сервер не может выполнять операции передачи файлов.

Состояния STARTING и STOPPING указывают, что сервер находится в промежуточном состоянии, либо не полностью отвечает, либо не полностью оффлайн. Значения START_FAILED или STOP_FAILED могут указывать на ошибку.

Tags -> (list)

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

(structure)

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

Key -> (string)

Название, назначенное созданному тегу.

Value -> (string)

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

UserCount -> (integer)

Указывает количество пользователей, назначенных на указанный вами сервер с помощью ServerId.

WorkflowDetails -> (structure)

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

Помимо потока, который выполняется при полном загрузке файла, WorkflowDetails также может содержать идентификатор потока (и роль выполнения) для потока, который выполняется при частичной загрузке. Частичная загрузка происходит при разрыве сеанса сервера во время загрузки файла.

OnUpload -> (list)

Триггер, запускающий поток: поток начинает выполняться после загрузки файла.

Чтобы удалить связанный поток с сервера, можно предоставить пустой объект OnUpload, как в следующем примере.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

Примечание

OnUpload может содержать не более одного объекта WorkflowDetail.

(structure)

Указывает идентификатор потока для назначения потока и роль выполнения, используемую для выполнения потока.

WorkflowId -> (string)

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

ExecutionRole -> (string)

Включает необходимые разрешения для операций S3, EFS и Lambda, которые может принять Transfer, чтобы все шаги потока могли работать с необходимыми ресурсами

OnPartialUpload -> (list)

Триггер, запускающий поток, если файл загружен только частично. Можно прикрепить поток к серверу, который выполняется всякий раз, когда происходит частичная загрузка.

Частичная загрузка происходит, когда файл открыт, а сеанс прерывается.

Примечание

OnPartialUpload может содержать не более одного объекта WorkflowDetail.

(structure)

WorkflowId -> (string)

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

ExecutionRole -> (string)

StructuredLogDestinations -> (list)

Указывает группы журналов, в которые отправляются журналы вашего сервера.

Чтобы указать группу журнала, необходимо предоставить ARN существующей группы журнала. В этом случае формат группы журнала следующий:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

Например, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

Если вы ранее указали группу журнала для сервера, вы можете очистить ее и фактически отключить структурированное ведение журнала, предоставив пустое значение для этого параметра в вызове update-server. Например:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

(string)

S3StorageOptions -> (structure)

Указывает, оптимизирована ли производительность каталогов Amazon S3. По умолчанию отключено.

По умолчанию, отображения домашнего каталога имеют TYPE значение DIRECTORY. Если вы включите этот параметр, вам необходимо будет явно установить HomeDirectoryMapEntry Type в значение FILE, если вы хотите, чтобы отображение имело целевой файл.

DirectoryListingOptimization -> (string)

Указывает, оптимизирована ли производительность каталогов Amazon S3. По умолчанию отключено.

As2ServiceManagedEgressIpAddresses -> (list)

Список внешних IP-адресов этого сервера. Эти IP-адреса актуальны только для серверов, использующих протокол AS2. Они используются для отправки асинхронных MDN.

Эти IP-адреса назначаются автоматически при создании сервера AS2. Кроме того, если вы обновите существующий сервер и добавите протокол AS2, будут назначены и статические IP-адреса.

(string)

END_OF_DOCUMENT_MARKER