SftpContainerResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Sftp v13.5.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

propertyconnectionStringExpressionReferenceExpressionget

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

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for this resource.

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for this resource.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the atmoz SFTP endpoint.

Methods

methodwithHostKeyFilebuilder

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

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

Parameters

keyFilestring

keyTypeKeyType

Returns

SftpContainerResource

methodwithUserKeyFilebuilder

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

usernamestring

keyFilestring

keyTypeKeyType

Returns

SftpContainerResource

methodwithUsersFilebuilder

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

withUsersFile(usersFile: string): SftpContainerResource

Parameters

usersFilestring

Returns

SftpContainerResource