Transfer class

AWS Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.

Constructors

Transfer({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createServer({String? certificate, EndpointDetails? endpointDetails, EndpointType? endpointType, String? hostKey, IdentityProviderDetails? identityProviderDetails, IdentityProviderType? identityProviderType, String? loggingRole, List<Protocol>? protocols, String? securityPolicyName, List<Tag>? tags}) → Future<CreateServerResponse>
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.
createUser({required String role, required String serverId, required String userName, String? homeDirectory, List<HomeDirectoryMapEntry>? homeDirectoryMappings, HomeDirectoryType? homeDirectoryType, String? policy, String? sshPublicKeyBody, List<Tag>? tags}) → Future<CreateUserResponse>
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.
deleteServer({required String serverId}) → Future<void>
Deletes the file transfer protocol-enabled server that you specify.
deleteSshPublicKey({required String serverId, required String sshPublicKeyId, required String userName}) → Future<void>
Deletes a user's Secure Shell (SSH) public key.
deleteUser({required String serverId, required String userName}) → Future<void>
Deletes the user belonging to a file transfer protocol-enabled server you specify.
describeSecurityPolicy({required String securityPolicyName}) → Future<DescribeSecurityPolicyResponse>
Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.
describeServer({required String serverId}) → Future<DescribeServerResponse>
Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
describeUser({required String serverId, required String userName}) → Future<DescribeUserResponse>
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.
importSshPublicKey({required String serverId, required String sshPublicKeyBody, required String userName}) → Future<ImportSshPublicKeyResponse>
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.
listSecurityPolicies({int? maxResults, String? nextToken}) → Future<ListSecurityPoliciesResponse>
Lists the security policies that are attached to your file transfer protocol-enabled servers.
listServers({int? maxResults, String? nextToken}) → Future<ListServersResponse>
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
listTagsForResource({required String arn, int? maxResults, String? nextToken}) → Future<ListTagsForResourceResponse>
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
listUsers({required String serverId, int? maxResults, String? nextToken}) → Future<ListUsersResponse>
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startServer({required String serverId}) → Future<void>
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.
stopServer({required String serverId}) → Future<void>
Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
tagResource({required String arn, required List<Tag> tags}) → Future<void>
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
testIdentityProvider({required String serverId, required String userName, Protocol? serverProtocol, String? sourceIp, String? userPassword}) → Future<TestIdentityProviderResponse>
If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.
toString() → String
A string representation of this object.
inherited
untagResource({required String arn, required List<String> tagKeys}) → Future<void>
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
updateServer({required String serverId, String? certificate, EndpointDetails? endpointDetails, EndpointType? endpointType, String? hostKey, IdentityProviderDetails? identityProviderDetails, String? loggingRole, List<Protocol>? protocols, String? securityPolicyName}) → Future<UpdateServerResponse>
Updates the file transfer protocol-enabled server's properties after that server has been created.
updateUser({required String serverId, required String userName, String? homeDirectory, List<HomeDirectoryMapEntry>? homeDirectoryMappings, HomeDirectoryType? homeDirectoryType, String? policy, String? role}) → Future<UpdateUserResponse>
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

Operators

operator ==(Object other) → bool
The equality operator.
inherited