CfnAccessPointProps

class aws_cdk.aws_efs.CfnAccessPointProps(*, file_system_id, access_point_tags=None, client_token=None, posix_user=None, root_directory=None)

Bases: object

Properties for defining a CfnAccessPoint.

Parameters:
  • file_system_id (str) – The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2 .

  • access_point_tags (Optional[Sequence[Union[AccessPointTagProperty, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • client_token (Optional[str]) – The opaque string specified in the request to ensure idempotent creation.

  • posix_user (Union[IResolvable, PosixUserProperty, Dict[str, Any], None]) – The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

  • root_directory (Union[IResolvable, RootDirectoryProperty, Dict[str, Any], None]) – The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html

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

cfn_access_point_props = efs.CfnAccessPointProps(
    file_system_id="fileSystemId",

    # the properties below are optional
    access_point_tags=[efs.CfnAccessPoint.AccessPointTagProperty(
        key="key",
        value="value"
    )],
    client_token="clientToken",
    posix_user=efs.CfnAccessPoint.PosixUserProperty(
        gid="gid",
        uid="uid",

        # the properties below are optional
        secondary_gids=["secondaryGids"]
    ),
    root_directory=efs.CfnAccessPoint.RootDirectoryProperty(
        creation_info=efs.CfnAccessPoint.CreationInfoProperty(
            owner_gid="ownerGid",
            owner_uid="ownerUid",
            permissions="permissions"
        ),
        path="path"
    )
)

Attributes

access_point_tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:

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

client_token

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

See:

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

file_system_id

The ID of the EFS file system that the access point applies to.

Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2 .

See:

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

posix_user

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

See:

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

root_directory

The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

See:

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