Module: @kui-shell/plugin-s3
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/plugin-s3
Module: @kui-shell/plugin-s3
Table of contents
Classes
Interfaces
Type aliases
Properties
Functions
Type aliases
ProviderInitializer
Ƭ ProviderInitializer: Object
Type declaration
| Name | Type |
|---|---|
mountName | string |
init | (repl: default, reinit?: () => void) => S3Provider | Promise<S3Provider> | Promise<S3Provider[]> |
Defined in
plugins/plugin-s3/src/providers/model.ts:43
S3Provider
Ƭ S3Provider: ClientOptions & { bucketFilter?: BucketFilter ; directEndPoint?: string ; error?: Error ; isDefault?: boolean ; listBuckets?: ClientOptions ; mountName: string ; publicOnly?: boolean ; region?: string ; subdir?: string ; understandsFolders?: boolean }
Defined in
plugins/plugin-s3/src/providers/model.ts:23
Properties
eventBus
• eventBus: EventBus
Functions
addProviderInitializer
▸ addProviderInitializer(providerInitializers): void
Parameters
| Name | Type |
|---|---|
providerInitializers | ProviderInitializer[] |
Returns
void
Defined in
plugins/plugin-s3/src/providers/index.ts:35
getCurrentMounts
▸ getCurrentMounts(): Mount[]
Returns
Mount[]
a list of the providers, with info about mount status for each
Defined in
plugins/plugin-s3/src/vfs/responders.ts:39
minioConfig
▸ minioConfig(direct?): Promise<MinioConfig>
This takes the S3 providers that we know about, and produces a
model that can be fed into mc alias set. Special case: if this
user does not have a configured AWS provider (i.e. we have no AWS
S3 credentials for them), we will create an auth-less entry; this
will allow access to public AWS s3 buckets.
Parameters
| Name | Type | Default value |
|---|---|---|
direct | boolean | false |
Returns
Promise<MinioConfig>