Aller au contenu
English

S3TransportOptions

import type { S3TransportOptions } from "@elie-laloum/outpost/transports/s3";
  • clientRequis
    S3Client
    S3Client configuré par l’appelant avec région, identifiants et éventuel endpoint compatible. Outpost ne le détruit pas et ne transmet pas ses identifiants aux sandboxes.
  • bucketRequis
    string
    Bucket privé existant qui prend en charge PUT conditionnel et la pagination, ainsi que DELETE conditionnel dans le mode de suppression par défaut. Le transport ne le crée jamais ; un nom vide est refusé.
  • prefixOptionnel
    string | undefined
    Préfixe des clés de tous les objets Outpost, racine du bucket par défaut ; doit être une clé de transport valide, slash final accepté. Gardez les objets sans rapport en dehors.
  • deleteModeOptionnel
    "conditional" | "tombstone" | undefined
    Fonctionnement de remove() : “conditional” (défaut) envoie un DELETE conditionnel ; “tombstone”, pour R2, remplace l’objet par un marqueur masqué de 1 Kio et fait envoyer à list() un HEAD par objet. Tous les écrivains d’un préfixe doivent utiliser le même mode ; ne purgez les marqueurs qu’après les avoir tous arrêtés.
import type { S3Client } from "@aws-sdk/client-s3";

export interface S3TransportOptions {
  readonly client: S3Client;
  readonly bucket: string;
  readonly prefix?: string;
  readonly deleteMode?: "conditional" | "tombstone";
}