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
,IFileSystem
,IResource
,IResource.Jsii$Default
,IResourceWithPolicy
,IResourceWithPolicy.Jsii$Default
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IFileSystem.Jsii$Proxy
- Enclosing interface:
IFileSystem
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.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
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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
The network connections associated with this resource.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default String
The ARN of the file system.default String
The ID of the file system, assigned by Amazon EFS.default software.constructs.IDependable
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, @NotNull 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
The network connections associated with this resource.- Specified by:
getConnections
in interfaceIConnectable
- Specified by:
getConnections
in interfaceIConnectable.Jsii$Default
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
- Specified by:
getNode
in interfaceIResourceWithPolicy.Jsii$Default
-
getEnv
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.
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
- Specified by:
getEnv
in interfaceIResourceWithPolicy.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
- Specified by:
getStack
in interfaceIResourceWithPolicy.Jsii$Default
-
getFileSystemArn
The ARN of the file system.- Specified by:
getFileSystemArn
in interfaceIFileSystem
-
getFileSystemId
The ID of the file system, assigned by Amazon EFS.- Specified by:
getFileSystemId
in interfaceIFileSystem
-
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 interfaceIFileSystem
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResourceWithPolicy.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addToResourcePolicy
@Stability(Stable) @NotNull default AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement) Add a statement to the resource's resource policy.- Specified by:
addToResourcePolicy
in interfaceIResourceWithPolicy
- Specified by:
addToResourcePolicy
in interfaceIResourceWithPolicy.Jsii$Default
- Parameters:
statement
- This parameter is required.
-
grant
@Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) Grant the actions defined in actions to the given grantee on this File System resource.- Specified by:
grant
in interfaceIFileSystem
- Parameters:
grantee
- This parameter is required.actions
- This parameter is required.
-
grantRead
Grant read permissions for this file system to an IAM principal.- Specified by:
grantRead
in interfaceIFileSystem
- Parameters:
grantee
- The principal to grant read to. This parameter is required.
-
grantReadWrite
Grant read and write permissions for this file system to an IAM principal.- Specified by:
grantReadWrite
in interfaceIFileSystem
- Parameters:
grantee
- The principal to grant read and write to. This parameter is required.
-
grantRootAccess
As root user, grant read and write permissions for this file system to an IAM principal.- Specified by:
grantRootAccess
in interfaceIFileSystem
- Parameters:
grantee
- The principal to grant root access to. This parameter is required.
-