createServer method

Future<CreateServerResponse> createServer({ String? certificate, EndpointDetails? endpointDetails, EndpointType? endpointType, String? hostKey, IdentityProviderDetails? identityProviderDetails, IdentityProviderType? identityProviderType, String? loggingRole, List<Protocol>? protocols, String? securityPolicyName, List<Tag>? tags, })

Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

May throw AccessDeniedException. May throw ServiceUnavailableException. May throw InternalServiceError. May throw InvalidRequestException. May throw ResourceExistsException. May throw ThrottlingException.

Parameter certificate : The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

• 2048-bit RSA (RSA_2048)
• 4096-bit RSA (RSA_4096)
• Elliptic Prime Curve 256 bit (EC_prime256v1)
• Elliptic Prime Curve 384 bit (EC_secp384r1)
• Elliptic Prime Curve 521 bit (EC_secp521r1)

Parameter endpointDetails : The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Parameter endpointType : The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

Parameter hostKey : The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key command. For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Parameter identityProviderDetails : Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

Parameter identityProviderType : Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Parameter loggingRole : Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

Parameter protocols : Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

• SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
• FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
• FTP (File Transfer Protocol): Unencrypted file transfer

Implementation

Future<CreateServerResponse> createServer({
  String? certificate,
  EndpointDetails? endpointDetails,
  EndpointType? endpointType,
  String? hostKey,
  IdentityProviderDetails? identityProviderDetails,
  IdentityProviderType? identityProviderType,
  String? loggingRole,
  List<Protocol>? protocols,
  String? securityPolicyName,
  List<Tag>? tags,
}) async {
  _s.validateStringLength(
    'certificate',
    certificate,
    0,
    1600,
  );
  _s.validateStringLength(
    'hostKey',
    hostKey,
    0,
    4096,
  );
  _s.validateStringLength(
    'loggingRole',
    loggingRole,
    20,
    2048,
  );
  _s.validateStringLength(
    'securityPolicyName',
    securityPolicyName,
    0,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'TransferService.CreateServer'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (certificate != null) 'Certificate': certificate,
      if (endpointDetails != null) 'EndpointDetails': endpointDetails,
      if (endpointType != null) 'EndpointType': endpointType.toValue(),
      if (hostKey != null) 'HostKey': hostKey,
      if (identityProviderDetails != null)
        'IdentityProviderDetails': identityProviderDetails,
      if (identityProviderType != null)
        'IdentityProviderType': identityProviderType.toValue(),
      if (loggingRole != null) 'LoggingRole': loggingRole,
      if (protocols != null)
        'Protocols': protocols.map((e) => e.toValue()).toList(),
      if (securityPolicyName != null)
        'SecurityPolicyName': securityPolicyName,
      if (tags != null) 'Tags': tags,
    },
  );

  return CreateServerResponse.fromJson(jsonResponse.body);
}