API.md

API Reference

Classes

Name	Description
SyncSource	No description
SyncedAccessPoint	No description

Structs

Name	Description
GithubSourceProps	No description
S3ArchiveSourceProps	No description
SyncSourceProps	No description
SyncedAccessPointProps	No description

class SyncSource

Initializer

new SyncSource()

Methods

static github(props)

static github(props: GithubSourceProps): SyncSource

• props (GithubSourceProps) No description
  • vpc (IVpc) The VPC of the Amazon EFS Filesystem.
  • syncDirectoryPath (string) The (absolute) directory path inside the EFS AccessPoint to sync files to. Optional
  • timeout (Duration) Timeout duration for sync Lambda function. Optional
  • vpcSubnets (SubnetSelection) Where to place the network interfaces within the VPC. Optional
  • repository (string) The github repository HTTP URI.

Returns:

• SyncSource

static s3Archive(props)

static s3Archive(props: S3ArchiveSourceProps): SyncSource

• props (S3ArchiveSourceProps) No description
  • vpc (IVpc) The VPC of the Amazon EFS Filesystem.
  • syncDirectoryPath (string) The (absolute) directory path inside the EFS AccessPoint to sync files to. Optional
  • timeout (Duration) Timeout duration for sync Lambda function. Optional
  • vpcSubnets (SubnetSelection) Where to place the network interfaces within the VPC. Optional
  • bucket (IBucket) The S3 bucket containing the archive file.
  • zipFilePath (string) The path of the zip file to extract in the S3 bucket.
  • syncOnUpdate (boolean) If this is set to true, then whenever a new object is uploaded to the specified path, an EFS sync will be triggered. Optional

Returns:

• SyncSource

class SyncedAccessPoint

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IAccessPoint, IConstruct, IDependable, IConstruct, IResource, IAccessPoint, IConstruct, IDependable, IConstruct, IResource Extends: AccessPoint

Initializer

new SyncedAccessPoint(scope: Construct, id: string, props: SyncedAccessPointProps)

• scope (Construct) No description
• id (string) No description
• props (SyncedAccessPointProps) No description
  • createAcl (Acl) Specifies the POSIX IDs and permissions to apply when creating the access point's root directory. Default: None. The directory specified by path must exist.
  • path (string) Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. Default: '/'
  • posixUser (PosixUser) The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point. Default: user identity not enforced
  • fileSystem (IFileSystem) The efs filesystem.
  • syncSource (SyncSource) No description

struct GithubSourceProps

Name	Type	Description
repository	string	The github repository HTTP URI.
vpc	IVpc	The VPC of the Amazon EFS Filesystem.
syncDirectoryPath?	string	The (absolute) directory path inside the EFS AccessPoint to sync files to. Optional
timeout?	Duration	Timeout duration for sync Lambda function. Optional
vpcSubnets?	SubnetSelection	Where to place the network interfaces within the VPC. Optional

struct S3ArchiveSourceProps

Name	Type	Description
bucket	IBucket	The S3 bucket containing the archive file.
vpc	IVpc	The VPC of the Amazon EFS Filesystem.
zipFilePath	string	The path of the zip file to extract in the S3 bucket.
syncDirectoryPath?	string	The (absolute) directory path inside the EFS AccessPoint to sync files to. Optional
syncOnUpdate?	boolean	If this is set to true, then whenever a new object is uploaded to the specified path, an EFS sync will be triggered. Optional
timeout?	Duration	Timeout duration for sync Lambda function. Optional
vpcSubnets?	SubnetSelection	Where to place the network interfaces within the VPC. Optional

struct SyncSourceProps

Name	Type	Description
vpc	IVpc	The VPC of the Amazon EFS Filesystem.
syncDirectoryPath?	string	The (absolute) directory path inside the EFS AccessPoint to sync files to. Optional
timeout?	Duration	Timeout duration for sync Lambda function. Optional
vpcSubnets?	SubnetSelection	Where to place the network interfaces within the VPC. Optional

struct SyncedAccessPointProps

Name	Type	Description
fileSystem🔹	IFileSystem	The efs filesystem.
syncSource	SyncSource
createAcl?🔹	Acl	Specifies the POSIX IDs and permissions to apply when creating the access point's root directory. Default: None. The directory specified by path must exist.
path?🔹	string	Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. Default: '/'
posixUser?🔹	PosixUser	The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point. Default: user identity not enforced