ListedServer - AWS Transfer Family
ContenidoVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

ListedServer

Devuelve las propiedades de un servidor habilitado para el protocolo de File Transfer que se especificó.

Contenido

Arn

Especifica el nombre de recurso de Amazon (ARN) único de un servidor que se va a incluir en la lista.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 1600 caracteres.

Patrón: arn:\S+

Obligatorio: sí

Domain

Especifica el dominio del sistema de almacenamiento que se utiliza para las transferencias de archivos. Hay dos dominios disponibles: Amazon Simple Storage Service (Amazon S3) y Amazon Elastic File System (Amazon EFS). El valor predeterminado es S3.

Tipo: cadena

Valores válidos: S3 | EFS

Obligatorio: no

EndpointType

Especifica el tipo de punto de conexión de VPC al que esté conectado su servidor. Si su servidor está conectado a un punto de conexión de VPC, su servidor no será accesible a través de la Internet pública.

Tipo: cadena

Valores válidos: PUBLIC | VPC | VPC_ENDPOINT

Obligatorio: no

IdentityProviderType

El modo de autenticación de un servidor. El valor predeterminado esSERVICE_MANAGED, que le permite almacenar y acceder a las credenciales de usuario dentro del AWS Transfer Family servicio.

Úselo AWS_DIRECTORY_SERVICE para proporcionar acceso a los grupos de Active Directory AWS Directory Service for Microsoft Active Directory o a Microsoft Active Directory en su entorno local o AWS mediante AD Connector. Esta opción también requiere que se especifique el ID del directorio mediante el parámetro IdentityProviderDetails.

Utilice el valor API_GATEWAY para la integración con un proveedor de identidades de su elección. La configuración de API_GATEWAY requiere que proporcione un punto de conexión de Amazon API Gateway para solicitar la autenticación mediante el parámetro IdentityProviderDetails.

Usa el AWS_LAMBDA valor para usar directamente una AWS Lambda función como proveedor de identidades. Si elige este valor, debe especificar el ARN de la función de Lambda en el parámetro Function para el tipo de datos de IdentityProviderDetails.

Tipo: cadena

Valores válidos: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

Obligatorio: no

LoggingRole

El nombre de recurso de Amazon (ARN) de la función AWS Identity and Access Management (IAM) que permite a un servidor activar el CloudWatch registro de Amazon para Amazon S3 o Amazon EFSEvents. Cuando esté configurado, podrá ver la actividad de los usuarios en sus registros. CloudWatch

Tipo: cadena

Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 2048 caracteres.

Patrón: arn:.*role/\S+

Obligatorio: no

ServerId

Especifica el identificador único asignado por el sistema para los servidores que figuraban en la lista.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: s-([0-9a-f]{17})

Obligatorio: no

State

Estado del servidor que se describió. Un valor de ONLINE indica que el servidor puede aceptar trabajos y transferir archivos. Un valor State de OFFLINE significa que el servidor no puede realizar operaciones de File Transfer.

Los estados de STARTING y STOPPING indican que el servidor se encuentra en un estado intermedio; es decir, que no puede responder por completo o que no está completamente desconectado. Los valores de START_FAILED o STOP_FAILED pueden indicar una condición de error.

Tipo: cadena

Valores válidos: OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

Obligatorio: no

UserCount

Especifica el número de usuarios que están asignados a un servidor que especificó con el ServerId.

Tipo: entero

Obligatorio: no

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: