Class S3PersistenceAdapter

Implementation of PersistenceAdapter using AWS S3

Hierarchy

S3PersistenceAdapter

Implements

PersistenceAdapter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new S3PersistenceAdapter(config: object): S3PersistenceAdapter

- Defined in ask-sdk-s3-persistence-adapter/lib/attributes/persistence/S3PersistenceAdapter.ts:33
Parameters
- config: object
  - bucketName: string
  - Optional objectKeyGenerator?: ObjectKeyGenerator
  - Optional pathPrefix?: string
  - Optional s3Client?: S3
Returns S3PersistenceAdapter

Properties

Protected bucketName

bucketName: string

Protected objectKeyGenerator

objectKeyGenerator: ObjectKeyGenerator

Protected pathPrefix

pathPrefix: string

Protected s3Client

s3Client: S3

Methods

deleteAttributes

deleteAttributes(requestEnvelope: RequestEnvelope): Promise<void>

- Defined in ask-sdk-s3-persistence-adapter/lib/attributes/persistence/S3PersistenceAdapter.ts:113
Parameters
- requestEnvelope: RequestEnvelope
Returns Promise<void>

getAttributes

getAttributes(requestEnvelope: RequestEnvelope): Promise<object>

- Defined in ask-sdk-s3-persistence-adapter/lib/attributes/persistence/S3PersistenceAdapter.ts:52
Retrieves persistence attributes from AWS S3.

Parameters
- requestEnvelope: RequestEnvelope
  
  Request envelope used to generate object key.
Returns Promise<object>

saveAttributes

saveAttributes(requestEnvelope: RequestEnvelope, attributes: object): Promise<void>

- Defined in ask-sdk-s3-persistence-adapter/lib/attributes/persistence/S3PersistenceAdapter.ts:94
Saves persistence attributes to AWS S3.

Parameters
- requestEnvelope: RequestEnvelope
  
  Request envelope used to generate object key.
- attributes: object
  
  Attributes to be saved to DynamoDB.
  - [key: string]: string
Returns Promise<void>