2.224.0

interface IFileSystem

LanguageType name
.NETAmazon.CDK.AWS.EFS.IFileSystem
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsefs#IFileSystem
Javasoftware.amazon.awscdk.services.efs.IFileSystem
Pythonaws_cdk.aws_efs.IFileSystem
TypeScript (source)aws-cdk-lib » aws_efs » IFileSystem

Implemented by FileSystem

Obtainable from FileSystem.fromFileSystemAttributes()

Represents an Amazon EFS file system.

Properties

NameTypeDescription
connectionsConnectionsThe network connections associated with this resource.
envResourceEnvironmentThe environment this resource belongs to.
fileSystemArnstringThe ARN of the file system.
fileSystemIdstringThe ID of the file system, assigned by Amazon EFS.
mountTargetsAvailableIDependableDependable that can be depended upon to ensure the mount targets of the filesystem are ready.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

connections

Type: Connections

The network connections associated with this resource.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

fileSystemArn

Type: string

The ARN of the file system.

fileSystemId

Type: string

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

mountTargetsAvailable

Type: IDependable

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

node

Type: Node

The tree node.

stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
addToResourcePolicy(statement)Add a statement to the resource's resource policy.
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
grant(grantee, ...actions)Grant the actions defined in actions to the given grantee on this File System resource.
grantRead(grantee)Grant read permissions for this file system to an IAM principal.
grantReadWrite(grantee)Grant read and write permissions for this file system to an IAM principal.
grantRootAccess(grantee)As root user, grant read and write permissions for this file system to an IAM principal.

addToResourcePolicy(statement)

public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult

Parameters

Returns

Add a statement to the resource's resource policy.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

grant(grantee, ...actions)

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

Returns

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

grantRead(grantee)

public grantRead(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — The principal to grant read to.

Returns

Grant read permissions for this file system to an IAM principal.

grantReadWrite(grantee)

public grantReadWrite(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — The principal to grant read and write to.

Returns

Grant read and write permissions for this file system to an IAM principal.

grantRootAccess(grantee)

public grantRootAccess(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — The principal to grant root access to.

Returns

As root user, grant read and write permissions for this file system to an IAM principal.

← PreviousNext →