AccessPointProps

class aws_cdk.aws_efs.AccessPointProps(*, client_token=None, create_acl=None, path=None, posix_user=None, file_system)

Bases: AccessPointOptions

Properties for the AccessPoint.

Parameters:

  • client_token (Optional[str]) – The opaque string specified in the request to ensure idempotent creation. Default: - No client token

  • create_acl (Union[Acl, Dict[str, Any], None]) – Specifies the POSIX IDs and permissions to apply when creating the access point’s root directory. If the root directory specified by path does not exist, EFS creates the root directory and applies the permissions specified here. If the specified path does not exist, you must specify createAcl. Default: - None. The directory specified by path must exist.

  • path (Optional[str]) – Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. Default: ‘/’

  • posix_user (Union[PosixUser, Dict[str, Any], None]) – The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point. Specify this to enforce a user identity using an access point. Default: - user identity not enforced

  • file_system (IFileSystem) – The efs filesystem.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_efs as efs

# file_system: efs.FileSystem

access_point_props = efs.AccessPointProps(
    file_system=file_system,

    # the properties below are optional
    client_token="clientToken",
    create_acl=efs.Acl(
        owner_gid="ownerGid",
        owner_uid="ownerUid",
        permissions="permissions"
    ),
    path="path",
    posix_user=efs.PosixUser(
        gid="gid",
        uid="uid",

        # the properties below are optional
        secondary_gids=["secondaryGids"]
    )
)

Attributes

client_token

The opaque string specified in the request to ensure idempotent creation.

Default:

  • No client token

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-clienttoken

create_acl

Specifies the POSIX IDs and permissions to apply when creating the access point’s root directory.

If the root directory specified by path does not exist, EFS creates the root directory and applies the permissions specified here. If the specified path does not exist, you must specify createAcl.

Default:

  • None. The directory specified by path must exist.

file_system

The efs filesystem.

path

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system.

Default:

‘/’

posix_user

The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.

Specify this to enforce a user identity using an access point.

Default:

  • user identity not enforced

See: