@vertigis/viewer-spec
Version:
VertiGIS Viewer Specification
31 lines (30 loc) • 1.18 kB
TypeScript
import type { ServiceModelProperties } from "../common/ServiceModelProperties";
/**
* Configuration for an application specific shared storage share. Backed by an
* S3 api compatible service.
*/
export interface SharedStorageModelProperties extends ServiceModelProperties {
/**
* The bucket for the share.
*/
bucket?: string;
/**
* The endpoint to be used.
*/
endpoint?: string;
/**
* The portal item that holds the read write credentials for shared storage.
* Access to these credentials will be limited by its portal item sharing
* settings. This portal item should never be shared publicly as this would
* provide public read write access to your endpoint. Extra care should be
* given to restrict the scope of these credentials to only the specific
* endpoint and bucket needed.
*/
credentialsPortalItem?: string;
/**
* Additional config that will be passed to the S3 api config on
* initialization. (See
* https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html).
*/
additionalConfiguration?: Record<string, unknown>;
}