AwsS3StorageServiceModule

AwsS3StorageServiceModule is an S3-based AWS storage service module that provides an implementation for the Service model. This module creates S3 buckets for object storage with support for directory organization and remote file management. It provides scalable, durable storage for applications with configurable directory structures.

@example

TypeScript

import { AwsS3StorageServiceModule } from '@quadnix/octo-aws-cdk/modules/service/aws-s3-storage-service';

octo.loadModule(AwsS3StorageServiceModule, 'my-storage-module', {
  bucketName: 'my-app-storage',
  region: myRegion,
  remoteDirectoryPaths: ['uploads', 'documents', 'images']
});

@group

Modules/Service/AwsS3StorageService

@see

• AwsS3StorageServiceModuleSchema for the input schema.
• AModule to learn more about modules.
• Service to learn more about the Service model.

Hierarchy

• AModule<AwsS3StorageServiceModuleSchema, AwsS3StorageService>
  • AwsS3StorageServiceModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Resources

• S3StorageSchema

Constructors

constructor

• AwsS3StorageServiceModule(moduleId: string): AwsS3StorageServiceModule

• Inherited from AModule<AwsS3StorageServiceModuleSchema, AwsS3StorageService>.constructor

  Parameters

  • moduleId: string

  Returns AwsS3StorageServiceModule

Properties

readonlyinheritedmoduleId

moduleId: string

Inherited from AModule.moduleId

staticreadonlyinheritedMODULE_PACKAGE

MODULE_PACKAGE: string

Inherited from AModule.MODULE_PACKAGE

staticreadonlyinheritedMODULE_SCHEMA

MODULE_SCHEMA: any

Inherited from AModule.MODULE_SCHEMA

Methods

onInit

• onInit(inputs: AwsS3StorageServiceModuleSchema): Promise<AwsS3StorageService>

• Overrides AModule.onInit

  Parameters

  • inputs: AwsS3StorageServiceModuleSchema

  Returns Promise<AwsS3StorageService>

inheritedregisterHooks

• registerHooks(): { postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }

• Inherited from AModule.registerHooks

  Returns { postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }

  • optionalpostCommitHooks?: PostHookSignature[]

  • optionalpostModelActionHooks?: PostHookSignature[]

  • optionalpostResourceActionHooks?: PostHookSignature[]

  • optionalpreCommitHooks?: PreHookSignature[]

  • optionalpreModelActionHooks?: PreHookSignature[]

  • optionalpreResourceActionHooks?: PreHookSignature[]

registerMetadata

• registerMetadata(inputs: AwsS3StorageServiceModuleSchema): Promise<{ app: App; awsAccountId: string; awsRegionId: string }>

• Overrides AModule.registerMetadata

  Parameters

  • inputs: AwsS3StorageServiceModuleSchema

  Returns Promise<{ app: App; awsAccountId: string; awsRegionId: string }>