updateServer method

Future<UpdateServerResponse> updateServer({ required String serverId, String? certificate, EndpointDetails? endpointDetails, EndpointType? endpointType, String? hostKey, IdentityProviderDetails? identityProviderDetails, String? loggingRole, List<Protocol>? protocols, String? securityPolicyName, })

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

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

Parameter serverId : A system-assigned unique identifier for a server instance that the user account is assigned to.

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. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Parameter endpointType : The type of 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 ssh-keygen -N "" -m PEM -f my-new-server-key. For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Parameter identityProviderDetails : An array containing all of the information required to call a customer's authentication API method.

Parameter loggingRole : Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

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:

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

Implementation

Future<UpdateServerResponse> updateServer({
  required String serverId,
  String? certificate,
  EndpointDetails? endpointDetails,
  EndpointType? endpointType,
  String? hostKey,
  IdentityProviderDetails? identityProviderDetails,
  String? loggingRole,
  List<Protocol>? protocols,
  String? securityPolicyName,
}) async {
  ArgumentError.checkNotNull(serverId, 'serverId');
  _s.validateStringLength(
    'serverId',
    serverId,
    19,
    19,
    isRequired: true,
  );
  _s.validateStringLength(
    'certificate',
    certificate,
    0,
    1600,
  );
  _s.validateStringLength(
    'hostKey',
    hostKey,
    0,
    4096,
  );
  _s.validateStringLength(
    'loggingRole',
    loggingRole,
    0,
    2048,
  );
  _s.validateStringLength(
    'securityPolicyName',
    securityPolicyName,
    0,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'TransferService.UpdateServer'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ServerId': serverId,
      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 (loggingRole != null) 'LoggingRole': loggingRole,
      if (protocols != null)
        'Protocols': protocols.map((e) => e.toValue()).toList(),
      if (securityPolicyName != null)
        'SecurityPolicyName': securityPolicyName,
    },
  );

  return UpdateServerResponse.fromJson(jsonResponse.body);
}