Skip to main content

AwsS3StorageServiceModuleSchema

AwsS3StorageServiceModuleSchema is the input schema for the AwsS3StorageServiceModule module. This schema defines the configuration for S3-based storage services including bucket naming, region placement, and directory organization.

@group

Modules/Service/AwsS3StorageService

@see

AwsS3StorageServiceModule to learn more about the AwsS3StorageServiceModule module.

Index

Properties

bucketName

bucketName: string = ...

The name of the S3 bucket to create. This name must be globally unique across all AWS accounts and regions. Must follow S3 bucket naming conventions.

region

region: Region = ...

The AWS region where the S3 bucket will be created. The region must have AWS region anchors configured.

optionalremoteDirectoryPaths

remoteDirectoryPaths?: string[] = ...

Optional array of directory paths to create within the S3 bucket. These directories provide organization for stored objects and can be used for permission management and access control.

Page Options