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

• AModule<AwsEfsFilesystemModuleSchema, Filesystem>
  • AwsEfsFilesystemModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Resources

• EfsSchema

Constructors

constructor

• AwsEfsFilesystemModule(moduleId: string): AwsEfsFilesystemModule

• Inherited from AModule<AwsEfsFilesystemModuleSchema, Filesystem>.constructor

  Parameters

  • moduleId: string

  Returns AwsEfsFilesystemModule

Properties

readonlyinheritedmoduleId

moduleId: string

Inherited from AModule.moduleId

staticreadonlyinheritedMODULE_PACKAGE

MODULE_PACKAGE: string

Inherited from AModule.MODULE_PACKAGE

staticreadonlyinheritedMODULE_SCHEMA

MODULE_SCHEMA: any

Inherited from AModule.MODULE_SCHEMA

Methods

onInit

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

• Overrides AModule.onInit

  Parameters

  • inputs: AwsEfsFilesystemModuleSchema

  Returns Promise<AwsEfsFilesystem>

inheritedregisterHooks

• registerHooks(): { postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }

• Inherited from AModule.registerHooks

  Returns { postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }

  • optionalpostCommitHooks?: PostHookSignature[]

  • optionalpostModelActionHooks?: PostHookSignature[]

  • optionalpostResourceActionHooks?: PostHookSignature[]

  • optionalpreCommitHooks?: PreHookSignature[]

  • optionalpreModelActionHooks?: PreHookSignature[]

  • optionalpreResourceActionHooks?: PreHookSignature[]

registerMetadata

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

• Overrides AModule.registerMetadata

  Parameters

  • inputs: AwsEfsFilesystemModuleSchema

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