Package software.amazon.awscdk.services.efs

Interface PosixUser

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PosixUser.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.331Z")
@Stability(Stable)
public interface PosixUser
extends software.amazon.jsii.JsiiSerializable

Represents the PosixUser.

Example:

 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.efs.*;
 // create a new VPC
 Vpc vpc = new Vpc(this, "VPC");
 // create a new Amazon EFS filesystem
 FileSystem fileSystem = FileSystem.Builder.create(this, "Efs").vpc(vpc).build();
 // create a new access point from the filesystem
 AccessPoint accessPoint = fileSystem.addAccessPoint("AccessPoint", AccessPointOptions.builder()
         // set /export/lambda as the root of the access point
         .path("/export/lambda")
         // as /export/lambda does not exist in a new efs filesystem, the efs will create the directory with the following createAcl
         .createAcl(Acl.builder()
                 .ownerUid("1001")
                 .ownerGid("1001")
                 .permissions("750")
                 .build())
         // enforce the POSIX identity so lambda function will access with this identity
         .posixUser(PosixUser.builder()
                 .uid("1001")
                 .gid("1001")
                 .build())
         .build());
 Function fn = Function.Builder.create(this, "MyLambda")
         // mount the access point to /mnt/msg in the lambda runtime environment
         .filesystem(FileSystem.fromEfsAccessPoint(accessPoint, "/mnt/msg"))
         .runtime(Runtime.NODEJS_18_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PosixUser.Builder	A builder for PosixUser
static final class	PosixUser.Jsii$Proxy	An implementation for PosixUser

Method Summary

Modifier and Type	Method	Description
static PosixUser.Builder	builder()
String	getGid()	The POSIX group ID used for all file system operations using this access point.
default List<String>	getSecondaryGids()	Secondary POSIX group IDs used for all file system operations using this access point.
String	getUid()	The POSIX user ID used for all file system operations using this access point.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGid

@Stability(Stable)
@NotNull
String getGid()

The POSIX group ID used for all file system operations using this access point.

getUid

@Stability(Stable)
@NotNull
String getUid()

The POSIX user ID used for all file system operations using this access point.

getSecondaryGids

@Stability(Stable)
@Nullable
default List<String> getSecondaryGids()

Secondary POSIX group IDs used for all file system operations using this access point.

Default: - None

builder

@Stability(Stable)
static PosixUser.Builder builder()

Returns:

a PosixUser.Builder of PosixUser