ListedServer - AWS Transfer Family

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ListedServer

Renvoie les propriétés d'un serveur compatible avec le protocole de transfert de fichiers qui a été spécifié.

Table des matières

Arn

Spécifie le nom de ressource Amazon (ARN) unique pour un serveur à répertorier.

Type : chaîne

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.

Modèle : arn:\S+

Obligatoire : oui

Domain

Spécifie le domaine du système de stockage utilisé pour les transferts de fichiers. Deux domaines sont disponibles : Amazon Simple Storage Service (Amazon S3) et Amazon Elastic File System (Amazon EFS). La valeur par défaut est S3.

Type : chaîne

Valeurs valides : S3 | EFS

Obligatoire : non

EndpointType

Spécifie le type de point de terminaison VPC auquel votre serveur est connecté. Si votre serveur est connecté à un point de terminaison VPC, il n'est pas accessible via Internet public.

Type : chaîne

Valeurs valides : PUBLIC | VPC | VPC_ENDPOINT

Obligatoire : non

IdentityProviderType

Le mode d'authentification pour un serveur. La valeur par défaut estSERVICE_MANAGED, ce qui vous permet de stocker et d'accéder aux informations d'identification des utilisateurs au sein du AWS Transfer Family service.

AWS_DIRECTORY_SERVICEÀ utiliser pour fournir un accès aux groupes Active Directory AWS Directory Service for Microsoft Active Directory ou à Microsoft Active Directory dans votre environnement local ou à l' AWS aide d'AD Connector. Cette option exige également que vous indiquiez un ID de répertoire en utilisant le paramètre IdentityProviderDetails.

Utilisez la valeur API_GATEWAY à intégrer au fournisseur d'identité de votre choix. Le paramètre API_GATEWAY vous demande d'indiquer une URL de point de terminaison Amazon API Gateway à appeler pour l'authentification à l'aide du paramètreIdentityProviderDetails.

Utilisez la AWS_LAMBDA valeur pour utiliser directement une AWS Lambda fonction en tant que fournisseur d'identité. Si vous choisissez cette valeur, vous devez spécifier l'ARN de la fonction Lambda dans le Function paramètre du type de IdentityProviderDetails données.

Type : chaîne

Valeurs valides : SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

Obligatoire : non

LoggingRole

Le nom de ressource Amazon (ARN) du rôle AWS Identity and Access Management (IAM) qui permet à un serveur d'activer la CloudWatch journalisation Amazon pour Amazon S3 ou Amazon EFSEvents. Lorsque cette option est configurée, vous pouvez consulter l'activité des utilisateurs dans vos CloudWatch journaux.

Type : chaîne

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 2048.

Modèle : arn:.*role/\S+

Obligatoire : non

ServerId

Spécifie l'identifiant unique attribué par le système aux serveurs répertoriés.

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

Modèle : s-([0-9a-f]{17})

Obligatoire : non

State

État du serveur décrit. La valeur de ONLINE indique que le serveur peut accepter des tâches et transférer des fichiers. StateLa valeur de OFFLINE signifie que le serveur ne peut pas effectuer d'opérations de transfert de fichiers.

Les états de STARTING et STOPPING indiquent que le serveur est dans un état intermédiaire, qu'il n'est pas totalement en mesure de répondre ou qu'il n'est pas complètement hors ligne. Les valeurs de START_FAILED ou STOP_FAILED peuvent indiquer une condition d'erreur.

Type : chaîne

Valeurs valides : OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

Obligatoire : non

UserCount

Spécifie le nombre d'utilisateurs affectés à un serveur que vous avez spécifié avec leServerId.

Type : entier

Obligatoire : non

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :