RustFsResource

Handle

📦 CommunityToolkit.Aspire.Hosting.RustFs v13.5.0

interface RustFsResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  addBucket(bucketName: string): RustFsBucketResource;
  addBuckets(bucketNames: string[]): RustFsResource;
  withDataBindMount(source: string): RustFsResource;
  withDataVolume(name?: string): RustFsResource;
  withSigningRegion(region: string): RustFsResource;
}

5 members

Methods

methodaddBucketbuilder

Adds a bucket to the RustFs resource. The bucket is created by issuing a signed `PUT` request to the RustFs S3 API after the server resource becomes ready.

addBucket(bucketName: string): RustFsBucketResource

Parameters

bucketNamestring

Returns

RustFsBucketResource

methodaddBucketsbuilder

Adds multiple buckets to the RustFs resource. Each bucket is registered as its own `RustFsBucketResource` child resource and created via the RustFs S3 API once the server resource becomes ready.

addBuckets(bucketNames: string[]): RustFsResource

Parameters

bucketNamesstring[]

Returns

RustFsResource

methodwithDataBindMountbuilder

Adds a bind mount for the data folder to a RustFs container resource.

withDataBindMount(source: string): RustFsResource

Parameters

sourcestring

Returns

RustFsResource

methodwithDataVolumebuilder

Adds a named volume for the data folder to a RustFs container resource.

withDataVolume(name?: string): RustFsResource

Parameters

namestringoptional

Returns

RustFsResource

methodwithSigningRegionbuilder

Sets the AWS signing region used when creating buckets via the S3 API. Defaults to `us-east-1` if not specified.

withSigningRegion(region: string): RustFsResource

Parameters

regionstring

Returns

RustFsResource