# SftpSettings

- Kind: `class`
- Package: [CommunityToolkit.Aspire.Sftp](/reference/api/csharp/communitytoolkit.aspire.sftp.md)
- Version: `13.4.0`
- Namespace: `CommunityToolkit.Aspire.Sftp`
- Target framework: `net10.0`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Provides the client configuration settings for connecting to an SFTP server using SSH.NET.

## Definition

```csharp
namespace CommunityToolkit.Aspire.Sftp;

public sealed class SftpSettings
{
    // ...
}
```

## Constructors

- [SftpSettings](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/constructors.md#constructor)

## Properties

- [ConnectionString](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/properties.md#connectionstring) : `string?` `get; set` -- Gets or sets the connection string in the format "sftp://host:port".
- [DisableHealthChecks](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/properties.md#disablehealthchecks) : `bool` `get; set` -- Gets or sets a boolean value that indicates whether the SFTP health check is disabled or not.
- [DisableTracing](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/properties.md#disabletracing) : `bool` `get; set` -- Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.
- [HealthCheckTimeout](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/properties.md#healthchecktimeout) : `TimeSpan?` `get; set` -- Gets or sets the timeout duration for the health check.
- [Password](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/properties.md#password) : `string?` `get; set` -- Gets or sets the password for SFTP authentication.
- [PrivateKeyFile](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/properties.md#privatekeyfile) : `string?` `get; set` -- Gets or sets the path to a private key file for SFTP authentication.
- [PrivateKeyPassphrase](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/properties.md#privatekeypassphrase) : `string` `get; set` -- Gets or sets the passphrase for the private key file for SFTP authentication.
- [Username](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings/properties.md#username) : `string?` `get; set` -- Gets or sets the username for SFTP authentication.