Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AwsSnapshotStore

Interface for SnapshotStore powered by AWS S3

Hierarchy

Index

Constructors

constructor

  • Parameters

    • config: object
      • bucketName: string
      • Optional keyPrefix?: undefined | string
      • Optional manageBucket?: undefined | true | false
      • Optional s3ClientConfiguration?: S3.ClientConfiguration

    Returns AwsSnapshotStore

Properties

Optional awsConfig

awsConfig: ConfigurationOptions

bucketName

bucketName: string

keyPrefix

keyPrefix: string = ""

manageBucket

manageBucket: boolean = false

s3

s3: S3

Optional s3ClientConfiguration

s3ClientConfiguration: S3.ClientConfiguration

Methods

deleteSnapshots

  • deleteSnapshots(): Promise<void>

readSnapshot

setup

  • setup(): Promise<void>

teardown

  • teardown(): Promise<void>

writeSnapshot

  • writeSnapshot(type: string, key: string, payload: object): Promise<void>

Generated using TypeDoc