Package software.amazon.awscdk.services.efs

Interface IFileSystem.Jsii$Default

All Superinterfaces:

IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IFileSystem, IResource, IResource.Jsii$Default, IResourceWithPolicy, IResourceWithPolicy.Jsii$Default, IResourceWithPolicyV2, IResourceWithPolicyV2.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IFileSystem.Jsii$Proxy

Enclosing interface:

IFileSystem

@Internal
public static interface IFileSystem.Jsii$Default
extends IFileSystem, IConnectable.Jsii$Default, IResourceWithPolicy.Jsii$Default

Internal default implementation for IFileSystem.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

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

IFileSystem.Jsii$Default, IFileSystem.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IResourceWithPolicy

IResourceWithPolicy.Jsii$Default, IResourceWithPolicy.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IResourceWithPolicyV2

IResourceWithPolicyV2.Jsii$Default, IResourceWithPolicyV2.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement)	Add a statement to the resource's resource policy.
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default Connections	getConnections()	The network connections associated with this resource.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default String	getFileSystemArn()	The ARN of the file system.
default String	getFileSystemId()	The ID of the file system, assigned by Amazon EFS.
default software.constructs.IDependable	getMountTargetsAvailable()	Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.
default software.constructs.Node	getNode()	The tree node.
default Stack	getStack()	The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, String... actions)	Grant the actions defined in actions to the given grantee on this File System resource.
default Grant	grantRead(IGrantable grantee)	Grant read permissions for this file system to an IAM principal.
default Grant	grantReadWrite(IGrantable grantee)	Grant read and write permissions for this file system to an IAM principal.
default Grant	grantRootAccess(IGrantable grantee)	As root user, grant read and write permissions for this file system to an IAM principal.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnections

@Stability(Stable)
@NotNull
default Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IResourceWithPolicy

Specified by:

getEnv in interface IResourceWithPolicy.Jsii$Default

Specified by:

getEnv in interface IResourceWithPolicyV2.Jsii$Default

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IResourceWithPolicy.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IResourceWithPolicy.Jsii$Default

getFileSystemArn

@Stability(Stable)
@NotNull
default String getFileSystemArn()

The ARN of the file system.

Specified by:

getFileSystemArn in interface IFileSystem

getFileSystemId

@Stability(Stable)
@NotNull
default String getFileSystemId()

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

Specified by:

getFileSystemId in interface IFileSystem

getMountTargetsAvailable

@Stability(Stable)
@NotNull
default software.constructs.IDependable getMountTargetsAvailable()

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

Specified by:

getMountTargetsAvailable in interface IFileSystem

addToResourcePolicy

@Stability(Stable)
@NotNull
default AddToResourcePolicyResult addToResourcePolicy(@NotNull
 PolicyStatement statement)

Add a statement to the resource's resource policy.

Specified by:

addToResourcePolicy in interface IResourceWithPolicy.Jsii$Default

Specified by:

addToResourcePolicy in interface IResourceWithPolicyV2

Specified by:

addToResourcePolicy in interface IResourceWithPolicyV2.Jsii$Default

Parameters:

statement - This parameter is required.

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResourceWithPolicy.Jsii$Default

Parameters:

policy - This parameter is required.

grant

@Stability(Stable)
@NotNull
default Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 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 - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(Stable)
@NotNull
default Grant grantRead(@NotNull
 IGrantable grantee)

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

Specified by:

grantRead in interface IFileSystem

Parameters:

grantee - The principal to grant read to. This parameter is required.

grantReadWrite

@Stability(Stable)
@NotNull
default Grant grantReadWrite(@NotNull
 IGrantable grantee)

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

Specified by:

grantReadWrite in interface IFileSystem

Parameters:

grantee - The principal to grant read and write to. This parameter is required.

grantRootAccess

@Stability(Stable)
@NotNull
default Grant grantRootAccess(@NotNull
 IGrantable grantee)

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

Specified by:

grantRootAccess in interface IFileSystem

Parameters:

grantee - The principal to grant root access to. This parameter is required.