interface IFileSystem
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EFS.IFileSystem |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsefs#IFileSystem |
![]() | software.amazon.awscdk.services.efs.IFileSystem |
![]() | aws_cdk.aws_efs.IFileSystem |
![]() | aws-cdk-lib » aws_efs » IFileSystem |
Implemented by
File
Obtainable from
File
.fromFileSystemAttributes()
Represents an Amazon EFS file system.
Properties
Name | Type | Description |
---|---|---|
connections | Connections | The network connections associated with this resource. |
env | Resource | The environment this resource belongs to. |
file | string | The ARN of the file system. |
file | string | The ID of the file system, assigned by Amazon EFS. |
mount | IDependable | Dependable that can be depended upon to ensure the mount targets of the filesystem are ready. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
connections
Type:
Connections
The network connections associated with this resource.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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
Name | Description |
---|---|
add | Add a statement to the resource's resource policy. |
apply | 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. |
grant | Grant read permissions for this file system to an IAM principal. |
grant | Grant read and write permissions for this file system to an IAM principal. |
grant | As root user, grant read and write permissions for this file system to an IAM principal. |
addToResourcePolicy(statement)
public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult
Parameters
- statement
Policy
Statement
Returns
Add a statement to the resource's resource policy.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
- grantee
IGrantable
- actions
string
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.