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

DescribedServer

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

Contenido

Arn

Especifica el nombre exclusivo de recurso de Amazon (ARN) del servidor.

Tipo: cadena

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

Patrón: arn:\S+

Obligatorio: sí

As2ServiceManagedEgressIpAddresses

La lista de direcciones IP de salida de este servidor. Estas direcciones IP solo son relevantes para los servidores que utilizan el AS2 protocolo. Se utilizan para el envío MDNs asíncrono.

Estas direcciones IP se asignan automáticamente al crear un servidor. AS2 Además, si actualiza un servidor existente y agrega el AS2 protocolo, también se asignan direcciones IP estáticas.

Tipo: matriz de cadenas

Patrón: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

Obligatorio: no

Certificate

Especifica el AWS certificado ARN de Certificate Manager (ACM). Necesario cuando Protocols se establece en FTPS.

Tipo: cadena

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

Obligatorio: no

Domain

Especifica el dominio del sistema de almacenamiento que se utiliza para las transferencias de archivos.

Tipo: cadena

Valores válidos: S3 | EFS

Obligatorio: no

EndpointDetails

La configuración del punto final de la nube privada virtual (VPC) que está configurada para su servidor. Cuando alojas tu terminal en tu terminalVPC, puedes hacer que solo los recursos de tu dispositivo sean accesibles o puedes adjuntar direcciones IP elásticas y hacer que los clientes puedan acceder a tu terminal a través de Internet. VPC Los grupos VPC de seguridad predeterminados se asignan automáticamente a su punto final.

Tipo: objeto EndpointDetails

Obligatorio: no

EndpointType

El tipo de punto de conexión al que está conectado el servidor. Si el servidor está conectado a un VPC punto final, no se puede acceder a él a través de la Internet pública.

Tipo: cadena

Valores válidos: PUBLIC | VPC | VPC_ENDPOINT

Obligatorio: no

HostKeyFingerprint

Especifica la SHA256 huella digital codificada en Base64 de la clave de host del servidor. El valor es el equivalente a la salida del comando ssh-keygen -l -f my-new-server-key.

Tipo: cadena

Requerido: no

IdentityProviderDetails

Especifica la información para llamar a una autenticación proporcionada por el cliente. API Este campo no se rellena cuando el IdentityProviderType de un servidor es AWS_DIRECTORY_SERVICE o SERVICE_MANAGED.

Tipo: objeto IdentityProviderDetails

Obligatorio: no

IdentityProviderType

El modo de autenticación de un servidor. El valor predeterminado esSERVICE_MANAGED, que permite almacenar las credenciales de usuario y acceder a ellas 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 API_GATEWAY configuración requiere que proporciones un punto de enlace de Amazon API Gateway URL para solicitar la autenticación mediante el IdentityProviderDetails parámetro.

Utilice el AWS_LAMBDA valor para utilizar directamente una AWS Lambda función como su proveedor de identidad. Si elige este valor, debe especificar el valor ARN para la función Lambda en el Function parámetro del tipo de IdentityProviderDetails datos.

Tipo: cadena

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

Obligatorio: no

LoggingRole

El nombre del 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 AmazonEFSevents. Cuando esté configurado, podrá ver la actividad de los usuarios en sus CloudWatch registros.

Tipo: cadena

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

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

Obligatorio: no

PostAuthenticationLoginBanner

Especifica una cadena para que se muestre cuando los usuarios se conecten a un servidor. Esta cadena se muestra después de que el usuario se autentique.

nota

El SFTP protocolo no admite banners gráficos posteriores a la autenticación.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 4 096 caracteres.

Patrón: [\x09-\x0D\x20-\x7E]*

Obligatorio: no

PreAuthenticationLoginBanner

Especifica una cadena para que se muestre cuando los usuarios se conecten a un servidor. Esta cadena se muestra antes de que el usuario se autentique. Por ejemplo, el siguiente banner muestra detalles sobre el uso del sistema:

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.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 4 096 caracteres.

Patrón: [\x09-\x0D\x20-\x7E]*

Obligatorio: no

ProtocolDetails

La configuración de protocolo configurados para su servidor.

  • Para indicar el modo pasivo (para FTP y FTPS protocolos), utilice el PassiveIp parámetro. Introduzca una única dirección cuádruple con puntos, como la IPv4 dirección IP externa de un firewall, un router o un balanceador de carga.

  • Utilice el parámetro SetStatOption para ignorar el error que se genera cuando el cliente intenta usar el comando SETSTAT en un archivo que esté cargando en un bucket de Amazon S3. Para que el AWS Transfer Family servidor ignore el SETSTAT comando y cargue los archivos sin necesidad de realizar ningún cambio en el SFTP cliente, defina el valor en. ENABLE_NO_OP Si estableces el SetStatOption parámetro enENABLE_NO_OP, Transfer Family generará una entrada de registro en Amazon CloudWatch Logs para que puedas determinar cuándo el cliente está realizando una SETSTAT llamada.

  • Para determinar si su AWS Transfer Family servidor reanuda las sesiones negociadas recientes mediante un identificador de sesión único, utilice el TlsSessionResumptionMode parámetro.

  • As2Transportsindica el método de transporte de los AS2 mensajes. En la actualidad, solo se admite HTTP.

Tipo: objeto ProtocolDetails

Obligatorio: no

Protocols

Especifica el protocolo o los protocolos de File Transfer a través de los cuales el cliente de protocolo de File Transfer puede conectarse al punto de enlace del servidor. Los protocolos disponibles son:

  • SFTP(Protocolo de transferencia de archivos Secure Shell (SSH)): transferencia de archivos mediante SSH

  • FTPS(Protocolo de transferencia de archivos seguro): transferencia de archivos TLS cifrada

  • FTP (Protocolo de File Transfer): transferencia de archivos sin cifrar

  • AS2(Declaración de aplicabilidad 2): se utiliza para transportar datos estructurados business-to-business

nota

  • Si lo seleccionaFTPS, debe elegir un certificado almacenado en AWS Certificate Manager (ACM) que se utilice para identificar su servidor cuando los clientes se conecten a él a través FTPS de él.

  • Si el Protocol incluye FTP o FTPS, el EndpointType debe ser VPC y el IdentityProviderType debe ser AWS_DIRECTORY_SERVICE, AWS_LAMBDA o API_GATEWAY.

  • Si Protocol incluye FTP, entonces AddressAllocationIds no se puede asociar.

  • Si el Protocol se establece solo en SFTP, se puede establecer el EndpointType como PUBLIC y el IdentityProviderType se puede configurar como cualquiera de los tipos de identidad admitidos: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA o API_GATEWAY.

  • Si Protocol incluye AS2, EndpointType debe ser VPC y el dominio debe ser Amazon S3.

Tipo: matriz de cadenas

Miembros de la matriz: número mínimo de 1 artículo. La cantidad máxima es de 4 elementos.

Valores válidos: SFTP | FTP | FTPS | AS2

Obligatorio: no

S3StorageOptions

Especifica si el rendimiento de los directorios de Amazon S3 está optimizado o no. Esta opción está deshabilitada de forma predeterminada.

De forma predeterminada, las asignaciones de los directorios principales tienen un TYPE valor de. DIRECTORY Si habilita esta opción, tendrá que establecerla de forma explícita FILE si HomeDirectoryMapEntry Type desea que la asignación tenga un destino de archivo.

Tipo: objeto S3StorageOptions

Obligatorio: no

SecurityPolicyName

Especifica el nombre de la política de seguridad que está asociada al servidor.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 100 caracteres.

Patrón: TransferSecurityPolicy-.+

Obligatorio: no

ServerId

Especifica el identificador único asignado por parte del sistema para un servidor del que se crea una instancia.

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

StructuredLogDestinations

Especifica los grupos de registro a los que se envían los registros de su servidor.

Para especificar un grupo de registros, debe proporcionar el ARN de un grupo de registros existente. En este caso, el formato del grupo de registros es el siguiente:

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

Por ejemplo, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* .

Si ha especificado previamente un grupo de registros para un servidor, puede borrarlo y desactivar el registro estructurado proporcionando un valor vacío para este parámetro en una llamada update-server. Por ejemplo:

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

Tipo: matriz de cadenas

Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 1 elemento.

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

Patrón: arn:\S+

Obligatorio: no

Tags

Especifica los pares clave-valor que puede usar para buscar y agrupar los servidores que se asignaron al servidor descrito.

Tipo: matriz de objetos Tag

Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 50 artículos.

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

WorkflowDetails

Especifica el ID del flujo de trabajo que se va a asignar y el rol de ejecución que se utiliza para ejecutar el flujo de trabajo.

Además de un flujo de trabajo que se ejecuta cuando un archivo se carga por completo, WorkflowDetails también puede contener un ID de flujo de trabajo (y un rol de ejecución) para que un flujo de trabajo se ejecute en una carga parcial. Se produce una carga parcial si la sesión de servidor se desconecta mientras se está cargando el archivo.

Tipo: objeto WorkflowDetails

Obligatorio: no

Véase también

Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: