Skip to main content

AwsS3StaticWebsiteServiceModule

AwsS3StaticWebsiteServiceModule is an S3-based AWS static website service module that provides an implementation for the Service model. This module creates S3 buckets configured for static website hosting with support for local file synchronization, filtering, and transformation capabilities. It manages the deployment of static websites from local directories to S3.

@example

TypeScript

import {
  AwsS3StaticWebsiteServiceModule
} from '@quadnix/octo-aws-cdk/modules/service/aws-s3-static-website-service';

octo.loadModule(AwsS3StaticWebsiteServiceModule, 'my-website-module', {
  bucketName: 'my-static-website',
  directoryPath: join(__dirname, 'website'),
  filter: (filePath) => !filePath.includes('.DS_Store'),
  region: 'us-east-1',
  subDirectoryOrFilePath: 'public',
  transform: (filePath) => `public/${filePath}`,
});
@group

Modules/Service/AwsS3StaticWebsiteService

@see

Hierarchy

Index

Constructors

Properties

Methods

Resources

Constructors

constructor

  • Parameters

    • moduleId: string

    Returns AwsS3StaticWebsiteServiceModule

Properties

readonlyinheritedmoduleId

moduleId: string

staticreadonlyinheritedMODULE_PACKAGE

MODULE_PACKAGE: string

staticreadonlyinheritedMODULE_SCHEMA

MODULE_SCHEMA: any

Methods

onInit

registerHooks

  • registerHooks(): { preCommitHooks?: { handle: (app: App, modelTransaction: DiffMetadata[][]) => Promise<void> }[] }

  • Returns { preCommitHooks?: { handle: (app: App, modelTransaction: DiffMetadata[][]) => Promise<void> }[] }

    • optionalpreCommitHooks?: { handle: (app: App, modelTransaction: DiffMetadata[][]) => Promise<void> }[]

registerMetadata

Page Options