AwsEfsFilesystemModule

AwsEfsFilesystemModule is an EFS-based AWS filesystem module that provides an implementation for the Filesystem model. This module creates AWS EFS (Elastic File System) filesystems that can be mounted and shared across multiple containers and services. It provides persistent, scalable file storage for containerized applications.

@example

TypeScript

import { AwsEfsFilesystemModule } from '@quadnix/octo-aws-cdk/modules/filesystem/aws-efs-filesystem';

octo.loadModule(AwsEfsFilesystemModule, 'my-filesystem-module', {
  filesystemName: 'shared-data',
  region: myRegion
});

@group

Modules/Filesystem/AwsEfsFilesystem

@see

• AwsEfsFilesystemModuleSchema for the input schema.
• AModule to learn more about modules.
• Filesystem to learn more about the Filesystem model.

Hierarchy

• unknown<AwsEfsFilesystemModuleSchema, Filesystem>
  • AwsEfsFilesystemModule

Index

Constructors

• constructor

Methods

• onInit
• registerMetadata

Resources

• EfsSchema

Constructors

constructor

• AwsEfsFilesystemModule(): AwsEfsFilesystemModule

• Inherited from AModule<AwsEfsFilesystemModuleSchema, Filesystem>.constructor

  Returns AwsEfsFilesystemModule

Methods

onInit

• onInit(inputs: AwsEfsFilesystemModuleSchema): Promise<AwsEfsFilesystem>

• Parameters

  • inputs: AwsEfsFilesystemModuleSchema

  Returns Promise<AwsEfsFilesystem>

registerMetadata

• registerMetadata(inputs: AwsEfsFilesystemModuleSchema): Promise<{ awsAccountId: string; awsRegionId: string }>

• Parameters

  • inputs: AwsEfsFilesystemModuleSchema

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