SftpContainerResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Sftp v13.4.0

interface SftpContainerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly port: EndpointReferenceExpression;
  readonly uriExpression: ReferenceExpression;
  withHostKeyFile(
      keyFile: string,
      keyType: KeyType): SftpContainerResource;
  withUserKeyFile(
      username: string,
      keyFile: string,
      keyType: KeyType): SftpContainerResource;
  withUsersFile(usersFile: string): SftpContainerResource;
}

7 members

Properties

property connectionStringExpression ReferenceExpression get

ConnectionString for the atmoz SFTP server in the form of sftp://host:port.

property host EndpointReferenceExpression get

Gets the host endpoint reference for this resource.

property port EndpointReferenceExpression get

Gets the port endpoint reference for this resource.

property uriExpression ReferenceExpression get

Gets the connection URI expression for the atmoz SFTP endpoint.

Methods

method withHostKeyFile builder

Adds a bind mount for the specified host key file to an SFTP container resource.

withHostKeyFile(
    keyFile: string,
    keyType: KeyType): SftpContainerResource

Parameters

keyFile string

keyType KeyType

Returns

SftpContainerResource

method withUserKeyFile builder

Adds a bind mount for the public key file of the specified user to an SFTP container resource.

withUserKeyFile(
    username: string,
    keyFile: string,
    keyType: KeyType): SftpContainerResource

Parameters

username string

keyFile string

keyType KeyType

Returns

SftpContainerResource

method withUsersFile builder

Adds a bind mount for the users.conf file to an SFTP container resource.

withUsersFile(usersFile: string): SftpContainerResource

Parameters

usersFile string

Returns

SftpContainerResource