Skip to main content

S3StorageConfig

S3StorageConfig represents the configuration that will be used if storage type is s3 within the client usage.
It composes of endpoint, region, bucket and credentials.

Each instance is produced automatically when creating a new rac-delta client with s3 storage type.


Structure

export interface S3StorageConfig extends BaseStorageConfig {
type: 's3';
endpoint?: string;
region?: string;
bucket: string;
credentials: {
accessKeyId: string;
secretAccessKey: string;
sessionToken?: string;
expiration?: Date;
};
}

Properties

PropertyTypeDescription
types3Const string that identifies this configuration as s3 storage configuration.
endpointstringOptional endpoint to the S3 storage.
regionstringOptional region where the S3 is.
bucketstringThe bucket name of the S3
credentialsObjectCredentials object composed of access key id, secret access key, session token and expiration.