software.amazon.awscdk.services.efs

Class FileSystem

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.efs.FileSystem

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, IFileSystem

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.662Z")
public class FileSystem
extends Resource
implements IFileSystem

The Elastic File System implementation of IFileSystem.

It creates a new, empty file system in Amazon Elastic File System (Amazon EFS). It also creates mount target (AWS::EFS::MountTarget) implicitly to mount the EFS file system on an Amazon Elastic Compute Cloud (Amazon EC2) instance or another resource.

Example:

 FileSystem fileSystem = FileSystem.Builder.create(this, "MyEfsFileSystem")
         .vpc(new Vpc(this, "VPC"))
         .lifecyclePolicy(LifecyclePolicy.AFTER_14_DAYS) // files are not transitioned to infrequent access (IA) storage by default
         .performanceMode(PerformanceMode.GENERAL_PURPOSE) // default
         .outOfInfrequentAccessPolicy(OutOfInfrequentAccessPolicy.AFTER_1_ACCESS)
         .build();
 

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystem.Builder A fluent builder for FileSystem.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.efs.IFileSystem

IFileSystem.Jsii$Default, IFileSystem.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Number	DEFAULT_PORT The default port File System listens on.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	FileSystem(software.amazon.jsii.JsiiObjectRef objRef)
	FileSystem(software.constructs.Construct scope, java.lang.String id, FileSystemProps props) Constructor for creating a new EFS FileSystem.

Method Summary

Modifier and Type	Method and Description
AccessPoint	addAccessPoint(java.lang.String id) create access point from this filesystem.
AccessPoint	addAccessPoint(java.lang.String id, AccessPointOptions accessPointOptions) create access point from this filesystem.
static IFileSystem	fromFileSystemAttributes(software.constructs.Construct scope, java.lang.String id, FileSystemAttributes attrs) Import an existing File System from the given properties.
Connections	getConnections() The security groups/rules used to allow network connections to the file system.
java.lang.String	getFileSystemArn() The ARN of the file system.
java.lang.String	getFileSystemId() The ID of the file system, assigned by Amazon EFS.
IDependable	getMountTargetsAvailable() Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.
Grant	grant(IGrantable grantee, java.lang.String... actions) Grant the actions defined in actions to the given grantee on this File System resource.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Field Detail

DEFAULT_PORT

public static final java.lang.Number DEFAULT_PORT

The default port File System listens on.

Constructor Detail

FileSystem

protected FileSystem(software.amazon.jsii.JsiiObjectRef objRef)

FileSystem

protected FileSystem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

FileSystem

public FileSystem(software.constructs.Construct scope,
                  java.lang.String id,
                  FileSystemProps props)

Constructor for creating a new EFS FileSystem.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromFileSystemAttributes

public static IFileSystem fromFileSystemAttributes(software.constructs.Construct scope,
                                                   java.lang.String id,
                                                   FileSystemAttributes attrs)

Import an existing File System from the given properties.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addAccessPoint

public AccessPoint addAccessPoint(java.lang.String id,
                                  AccessPointOptions accessPointOptions)

create access point from this filesystem.

Parameters:

id - This parameter is required.

accessPointOptions -

addAccessPoint

public AccessPoint addAccessPoint(java.lang.String id)

create access point from this filesystem.

Parameters:

id - This parameter is required.

grant

public Grant grant(IGrantable grantee,
                   java.lang.String... actions)

Grant the actions defined in actions to the given grantee on this File System resource.

Specified by:

grant in interface IFileSystem

Parameters:

grantee - Principal to grant right to. This parameter is required.

actions - The actions to grant. This parameter is required.

getConnections

public Connections getConnections()

The security groups/rules used to allow network connections to the file system.

Specified by:

getConnections in interface IConnectable

getFileSystemArn

public java.lang.String getFileSystemArn()

The ARN of the file system.

Specified by:

getFileSystemArn in interface IFileSystem

getFileSystemId

public java.lang.String getFileSystemId()

The ID of the file system, assigned by Amazon EFS.

Specified by:

getFileSystemId in interface IFileSystem

getMountTargetsAvailable

public IDependable getMountTargetsAvailable()

Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.

Specified by:

getMountTargetsAvailable in interface IFileSystem