Class FileSystem
The Elastic File System implementation of IFileSystem.
Inherited Members
Namespace: Amazon.CDK.AWS.EFS
Assembly: Amazon.CDK.AWS.EFS.dll
Syntax (csharp)
public class FileSystem : Resource, IFileSystem, IConnectable, IResource, IConstruct, IDependable
Syntax (vb)
Public Class FileSystem
Inherits Resource
Implements IFileSystem, IConnectable, IResource, IConstruct, IDependable
Remarks
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.
See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html
Resource: AWS::EFS::FileSystem
ExampleMetadata: infused
Examples
var fileSystem = new FileSystem(this, "MyEfsFileSystem", new FileSystemProps {
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
});
Synopsis
Constructors
FileSystem(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
FileSystem(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
FileSystem(Construct, String, IFileSystemProps) | Constructor for creating a new EFS FileSystem. |
Properties
Connections | The security groups/rules used to allow network connections to the file system. |
DEFAULT_PORT | The default port File System listens on. |
FileSystemArn | The ARN of the file system. |
FileSystemId | The ID of the file system, assigned by Amazon EFS. |
MountTargetsAvailable | Dependable that can be depended upon to ensure the mount targets of the filesystem are ready. |
Methods
AddAccessPoint(String, IAccessPointOptions) | create access point from this filesystem. |
FromFileSystemAttributes(Construct, String, IFileSystemAttributes) | Import an existing File System from the given properties. |
Grant(IGrantable, String[]) | Grant the actions defined in actions to the given grantee on this File System resource. |
Constructors
FileSystem(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected FileSystem(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
FileSystem(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected FileSystem(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
FileSystem(Construct, String, IFileSystemProps)
Constructor for creating a new EFS FileSystem.
public FileSystem(Construct scope, string id, IFileSystemProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IFileSystemProps
Properties
Connections
The security groups/rules used to allow network connections to the file system.
public virtual Connections_ Connections { get; }
Property Value
DEFAULT_PORT
The default port File System listens on.
public static double DEFAULT_PORT { get; }
Property Value
System.Double
FileSystemArn
The ARN of the file system.
public virtual string FileSystemArn { get; }
Property Value
System.String
Remarks
Attribute: true
FileSystemId
The ID of the file system, assigned by Amazon EFS.
public virtual string FileSystemId { get; }
Property Value
System.String
Remarks
Attribute: true
MountTargetsAvailable
Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.
public virtual IDependable MountTargetsAvailable { get; }
Property Value
Methods
AddAccessPoint(String, IAccessPointOptions)
create access point from this filesystem.
public virtual AccessPoint AddAccessPoint(string id, IAccessPointOptions accessPointOptions = null)
Parameters
- id System.String
- accessPointOptions IAccessPointOptions
Returns
FromFileSystemAttributes(Construct, String, IFileSystemAttributes)
Import an existing File System from the given properties.
public static IFileSystem FromFileSystemAttributes(Construct scope, string id, IFileSystemAttributes attrs)
Parameters
- scope Constructs.Construct
- id System.String
- attrs IFileSystemAttributes
Returns
Grant(IGrantable, String[])
Grant the actions defined in actions to the given grantee on this File System resource.
public virtual Grant Grant(IGrantable grantee, params string[] actions)
Parameters
- grantee IGrantable
Principal to grant right to.
- actions System.String[]
The actions to grant.
Returns