AwsS3StaticWebsiteServiceModuleSchema
Index
Properties
account
The AWS account that this service will be associated with. Only AWS account types are supported for this module.
awsRegionId
The AWS region that this service will be associated with.
bucketName
The name of the S3 bucket to create for the static website. This name must be globally unique across all AWS accounts and regions. Must follow S3 bucket naming conventions.
directoryPath
The local directory path containing the static website files. This is the source directory that will be synchronized to S3.
optionalfilter
Optional filter function to exclude specific files from upload. This function receives a file path and returns true to include the file or false to exclude it. Useful for excluding development files, system files, or temporary files.
optionalsubDirectoryOrFilePath
Optional subdirectory or specific file path within the source directory. When specified, only this subdirectory or file will be uploaded instead of the entire directory., but the path leading up to this subdirectory or file will still be preserved.
For example, if subDirectoryOrFilePath is subdirectory/file.html, only the file file.html will be uploaded,
but the path subdirectory/ will still be preserved. The URL will be my-website.com/subdirectory/file.html.
optionaltransform
Optional transform function to modify file paths before upload. This function receives the original file path and returns the transformed path. Useful for renaming files, changing directory structures, or modifying extensions.
AwsS3StaticWebsiteServiceModuleSchemais the input schema for theAwsS3StaticWebsiteServiceModulemodule. This schema defines the configuration for S3-based static website services including bucket naming, source directory management, and file processing options.Modules/Service/AwsS3StaticWebsiteService
AwsS3StaticWebsiteServiceModule to learn more about the
AwsS3StaticWebsiteServiceModulemodule.