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

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

Hierarchy

• unknown<AwsS3StaticWebsiteServiceModuleSchema, AwsS3StaticWebsiteService>
  • AwsS3StaticWebsiteServiceModule

Index

Constructors

• constructor

Methods

• onInit
• registerHooks
• registerMetadata

Resources

• S3WebsiteSchema

Constructors

constructor

• AwsS3StaticWebsiteServiceModule(): AwsS3StaticWebsiteServiceModule

• Inherited from AModule< AwsS3StaticWebsiteServiceModuleSchema, AwsS3StaticWebsiteService >.constructor

  Returns AwsS3StaticWebsiteServiceModule

Methods

onInit

• onInit(inputs: AwsS3StaticWebsiteServiceModuleSchema): Promise<AwsS3StaticWebsiteService>

• Parameters

  • inputs: AwsS3StaticWebsiteServiceModuleSchema

  Returns Promise<AwsS3StaticWebsiteService>

registerHooks

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

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

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

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

registerMetadata

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

• Parameters

  • inputs: AwsS3StaticWebsiteServiceModuleSchema

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