CreateServer

Crea una instancia de servidor virtual de escalado automático en función del protocolo de transferencia de archivos seleccionado en AWS. Cuando actualice su servidor habilitado por protocoles de transferencia de archivos o cuando trabaje con usuarios, use la propiedad ServerId generada por el servicio, la cual se asigna al servidor creado recientemente.

Sintaxis de la solicitud

{
   "Certificate": "string",
   "Domain": "string",
   "EndpointDetails": { 
      "AddressAllocationIds": [ "string" ],
      "SecurityGroupIds": [ "string" ],
      "SubnetIds": [ "string" ],
      "VpcEndpointId": "string",
      "VpcId": "string"
   },
   "EndpointType": "string",
   "HostKey": "string",
   "IdentityProviderDetails": { 
      "DirectoryId": "string",
      "Function": "string",
      "InvocationRole": "string",
      "SftpAuthenticationMethods": "string",
      "Url": "string"
   },
   "IdentityProviderType": "string",
   "LoggingRole": "string",
   "PostAuthenticationLoginBanner": "string",
   "PreAuthenticationLoginBanner": "string",
   "ProtocolDetails": { 
      "As2Transports": [ "string" ],
      "PassiveIp": "string",
      "SetStatOption": "string",
      "TlsSessionResumptionMode": "string"
   },
   "Protocols": [ "string" ],
   "S3StorageOptions": { 
      "DirectoryListingOptimization": "string"
   },
   "SecurityPolicyName": "string",
   "StructuredLogDestinations": [ "string" ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "WorkflowDetails": { 
      "OnPartialUpload": [ 
         { 
            "ExecutionRole": "string",
            "WorkflowId": "string"
         }
      ],
      "OnUpload": [ 
         { 
            "ExecutionRole": "string",
            "WorkflowId": "string"
         }
      ]
   }
}

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en JSON formato.

Certificate

El nombre del recurso de Amazon (ARN) del certificado AWS Certificate Manager (ACM). Necesario cuando Protocols se establece en FTPS.

Para solicitar un nuevo certificado público, consulte Solicitar un certificado público en la Guía del AWS Certificate Manager usuario.

Para importar un certificado existenteACM, consulte Importación de certificados a ACM en la Guía del AWS Certificate Manager usuario.

Para solicitar un certificado privado para usarlo a FTPS través de direcciones IP privadas, consulte Solicitar un certificado privado en la Guía del AWS Certificate Manager usuario.

Se admiten certificados con los siguientes algoritmos criptográficos y tamaños de clave:

• 2048 bits RSA (_2048) RSA

• 4096 bits (_4096) RSA RSA

• Curva elíptica principal de 256 bits (EC_prime256v1)

• Curva elíptica principal de 384 bits (EC_secp384r1)

• Curva elíptica principal de 521 bits (EC_secp521r1)

nota

El certificado debe ser un certificado válido FQDN o SSL TLS X.509, versión 3, con una dirección IP especificada e información sobre el emisor.

Tipo: cadena

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

Obligatorio: no

Domain

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 (AmazonEFS). El valor predeterminado es S3.

nota

Después de crear el servidor, el dominio no se puede cambiar.

Tipo: cadena

Valores válidos: S3 | EFS

Obligatorio: no

EndpointDetails

Los ajustes de punto final de la nube privada virtual (VPC) que están configurados 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 que desea que use el servidor. Puede elegir entre hacer que el punto final de su servidor sea de acceso público (PUBLIC) o alojarlo dentro del suyoVPC. Con un terminal alojado en unVPC, puede restringir el acceso a su servidor y a sus recursos únicamente dentro de su territorio VPC o elegir que esté orientado a Internet adjuntándole directamente las direcciones IP elásticas.

nota

Después del 19 de mayo de 2021, no podrás crear un servidor con EndpointType=VPC_ENDPOINT tu cuenta Cuenta de AWS si no lo ha hecho antes del 19 de mayo de 2021. Si ya has creado servidores EndpointType=VPC_ENDPOINT en tu cuenta Cuenta de AWS el 19 de mayo de 2021 o antes, no te afectará. Después de esta fecha, use EndpointType=VPC.

Para obtener más información, consulte Interrumpir el uso de _ VPC ENDPOINT.

Se recomienda que utilice VPC como EndpointType. Con este tipo de punto final, tiene la opción de asociar directamente hasta tres IPv4 direcciones elásticas (incluida la BYO IP) al punto final de su servidor y utilizar grupos de VPC seguridad para restringir el tráfico según la dirección IP pública del cliente. Esto no es posible si se establece EndpointType en VPC_ENDPOINT.

Tipo: cadena

Valores válidos: PUBLIC | VPC | VPC_ENDPOINT

Obligatorio: no

HostKey

La clave RSAECDSA, o la clave ED25519 privada que se utilizará en su servidor SFTP habilitado. Puede agregar varias claves de host, en caso de que desee rotar las claves, o tener un conjunto de claves activas que utilicen algoritmos diferentes.

Utilice el siguiente comando para generar una clave de RSA 2048 bits sin contraseña:

ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.

Utilice un valor mínimo de 2048 para la opción -b. Puede crear una clave más fuerte utilizando 3072 o 4096.

Utilice el siguiente comando para generar una clave de ECDSA 256 bits sin contraseña:

ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.

Los valores válidos para la -b opción ECDSA son 256, 384 y 521.

Utilice el siguiente comando para generar una ED25519 clave sin contraseña:

ssh-keygen -t ed25519 -N "" -f my-new-server-key.

Para todos estos comandos, puede my-new-server-keysustituirlos por la cadena que prefiera.

importante

Si no planea migrar los usuarios existentes de un servidor ya SFTP habilitado a un servidor nuevo, no actualice la clave de host. El cambio accidental de la clave de host de un servidor puede ser disruptivo.

Para obtener más información, consulta Actualizar las claves de host de tu servidor SFTP habilitado en la Guía del AWS Transfer Family usuario.

Tipo: cadena

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

Obligatorio: no

IdentityProviderDetails

Obligatorio cuando IdentityProviderType se establece en AWS_DIRECTORY_SERVICE, AWS_LAMBDA o API_GATEWAY. Acepta una matriz que contiene toda la información necesaria para utilizar un directorio AWS_DIRECTORY_SERVICE o invocar una autenticación proporcionada por el clienteAPI, incluida la puerta de enlace. API URL No es necesario cuando IdentityProviderType se establece en 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 servicio. AWS Transfer Family

Ú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

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

Pares clave-valor que se puede utilizar para agrupar y buscar servidores.

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

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

Sintaxis de la respuesta

{
   "ServerId": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.

El servicio devuelve los siguientes datos en JSON formato.

ServerId

El identificador asignado al servicio del servidor que se crea.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

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

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

AccessDeniedException

No tiene acceso suficiente para realizar esta acción.

HTTPCódigo de estado: 400

InternalServiceError

Esta excepción se produce cuando se produce un error en el AWS Transfer Family servicio.

HTTPCódigo de estado: 500

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.

HTTPCódigo de estado: 400

ResourceExistsException

El recurso solicitado no existe o existe en una región distinta de la especificada para el comando.

HTTPCódigo de estado: 400

ResourceNotFoundException

Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.

HTTPCódigo de estado: 400

ServiceUnavailableException

La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.

HTTPCódigo de estado: 500

ThrottlingException

La solicitud fue denegada debido a una limitación de la solicitud.

HTTPCódigo de estado: 400

Ejemplos

Ejemplo

En el siguiente ejemplo se crea un nuevo usuario usando un VPC_ENDPOINT.

Solicitud de muestra

{     
   "EndpointType": "VPC",
   "EndpointDetails":...,
   "HostKey": "Your RSA private key",
   "IdentityProviderDetails": "IdentityProvider",
   "IdentityProviderType": "SERVICE_MANAGED",
   "LoggingRole": "CloudWatchLoggingRole",
   "Tags": [ 
      { 
         "Key": "Name",
         "Value": "MyServer"
      }
   ]
}

Ejemplo

Este es un ejemplo de respuesta para esta API llamada.

Respuesta de ejemplo

{
   "ServerId": "s-01234567890abcdef"
}

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:

• Interfaz de la línea de comandos de AWS

• AWS SDKpara. NET

• AWS SDKpara C++

• AWS SDKpara Go

• AWS SDKpara Java V2

• AWS SDKpara JavaScript V3

• AWS SDKpara PHP V3

• AWS SDKpara Python

• AWS SDKpara Ruby V3