# SftpSettings Properties

- Package: [CommunityToolkit.Aspire.Sftp](/reference/api/csharp/communitytoolkit.aspire.sftp.md)
- Type: [SftpSettings](/reference/api/csharp/communitytoolkit.aspire.sftp/sftpsettings.md)
- Kind: `Properties`
- Members: `8`

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

## ConnectionString

- Name: `ConnectionString`
- Modifiers: `nullable` `get; set`
- Returns: `string?`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Gets or sets the connection string in the format "sftp://host:port".

```csharp
public string? ConnectionString { get; set; }
```

## DisableHealthChecks

- Name: `DisableHealthChecks`
- Modifiers: `get; set`
- Returns: `bool`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Gets or sets a boolean value that indicates whether the SFTP health check is disabled or not.

```csharp
public bool DisableHealthChecks { get; set; }
```

## DisableTracing

- Name: `DisableTracing`
- Modifiers: `get; set`
- Returns: `bool`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.

```csharp
public bool DisableTracing { get; set; }
```

## HealthCheckTimeout

- Name: `HealthCheckTimeout`
- Modifiers: `nullable` `get; set`
- Returns: `TimeSpan?`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Gets or sets the timeout duration for the health check.

```csharp
public TimeSpan? HealthCheckTimeout { get; set; }
```

## Password

- Name: `Password`
- Modifiers: `nullable` `get; set`
- Returns: `string?`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Gets or sets the password for SFTP authentication.

```csharp
public string? Password { get; set; }
```

## PrivateKeyFile

- Name: `PrivateKeyFile`
- Modifiers: `nullable` `get; set`
- Returns: `string?`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Gets or sets the path to a private key file for SFTP authentication.

```csharp
public string? PrivateKeyFile { get; set; }
```

## PrivateKeyPassphrase

- Name: `PrivateKeyPassphrase`
- Modifiers: `get; set`
- Returns: `string`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Gets or sets the passphrase for the private key file for SFTP authentication.

```csharp
public string PrivateKeyPassphrase { get; set; }
```

## Username

- Name: `Username`
- Modifiers: `nullable` `get; set`
- Returns: `string?`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.Sftp/SftpSettings.cs)

Gets or sets the username for SFTP authentication.

```csharp
public string? Username { get; set; }
```