CfnAccessPointPropsMixin

class aws_cdk.mixins_preview.aws_efs.mixins.CfnAccessPointPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::EFS::AccessPoint resource creates an EFS access point.

An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point’s root directory. Applications using the access point can only access data in its own directory and below. To learn more, see Mounting a file system using EFS access points .

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html
CloudformationResource:: AWS::EFS::AccessPoint
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_efs import mixins as efs_mixins

cfn_access_point_props_mixin = efs_mixins.CfnAccessPointPropsMixin(efs_mixins.CfnAccessPointMixinProps(
    access_point_tags=[efs_mixins.CfnAccessPointPropsMixin.AccessPointTagProperty(
        key="key",
        value="value"
    )],
    client_token="clientToken",
    file_system_id="fileSystemId",
    posix_user=efs_mixins.CfnAccessPointPropsMixin.PosixUserProperty(
        gid="gid",
        secondary_gids=["secondaryGids"],
        uid="uid"
    ),
    root_directory=efs_mixins.CfnAccessPointPropsMixin.RootDirectoryProperty(
        creation_info=efs_mixins.CfnAccessPointPropsMixin.CreationInfoProperty(
            owner_gid="ownerGid",
            owner_uid="ownerUid",
            permissions="permissions"
        ),
        path="path"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EFS::AccessPoint.

Parameters:

props (Union[CfnAccessPointMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessPointTags', 'clientToken', 'fileSystemId', 'posixUser', 'rootDirectory']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AccessPointTagProperty

class CfnAccessPointPropsMixin.AccessPointTagProperty(*, key=None, value=None)

Bases: object

A tag is a key-value pair attached to a file system.

Allowed characters in the Key and Value properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /

Parameters:

key (Optional[str]) – The tag key (String). The key can’t start with aws: .
value (Optional[str]) – The value of the tag key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-accesspointtag.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.mixins_preview.aws_efs import mixins as efs_mixins

access_point_tag_property = efs_mixins.CfnAccessPointPropsMixin.AccessPointTagProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key (String).

The key can’t start with aws: .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-accesspointtag.html#cfn-efs-accesspoint-accesspointtag-key

value

The value of the tag key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-accesspointtag.html#cfn-efs-accesspoint-accesspointtag-value

CreationInfoProperty

class CfnAccessPointPropsMixin.CreationInfoProperty(*, owner_gid=None, owner_uid=None, permissions=None)

Bases: object

Required if the RootDirectory > Path specified does not exist.

Specifies the POSIX IDs and permissions to apply to the access point’s RootDirectory > Path . If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo , you must include values for all properties.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail. .. epigraph:

If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` does not exist, attempts to mount the file system using the access point will fail.

Parameters:

owner_gid (Optional[str]) – Specifies the POSIX group ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).
owner_uid (Optional[str]) – Specifies the POSIX user ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).
permissions (Optional[str]) – Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file’s mode bits.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.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.mixins_preview.aws_efs import mixins as efs_mixins

creation_info_property = efs_mixins.CfnAccessPointPropsMixin.CreationInfoProperty(
    owner_gid="ownerGid",
    owner_uid="ownerUid",
    permissions="permissions"
)

Attributes

owner_gid

Specifies the POSIX group ID to apply to the RootDirectory .

Accepts values from 0 to 2^32 (4294967295).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-ownergid

owner_uid

Specifies the POSIX user ID to apply to the RootDirectory .

Accepts values from 0 to 2^32 (4294967295).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-owneruid

permissions

Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file’s mode bits.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-permissions

PosixUserProperty

class CfnAccessPointPropsMixin.PosixUserProperty(*, gid=None, secondary_gids=None, uid=None)

Bases: object

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.

Parameters:

gid (Optional[str]) – The POSIX group ID used for all file system operations using this access point.
secondary_gids (Optional[Sequence[str]]) – Secondary POSIX group IDs used for all file system operations using this access point.
uid (Optional[str]) – The POSIX user ID used for all file system operations using this access point.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-posixuser.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.mixins_preview.aws_efs import mixins as efs_mixins

posix_user_property = efs_mixins.CfnAccessPointPropsMixin.PosixUserProperty(
    gid="gid",
    secondary_gids=["secondaryGids"],
    uid="uid"
)

Attributes

gid

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

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

secondary_gids

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

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

uid

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

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

RootDirectoryProperty

class CfnAccessPointPropsMixin.RootDirectoryProperty(*, creation_info=None, path=None)

Bases: object

Specifies the directory on the Amazon EFS file system that the access point provides access to.

The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point’s RootDirectory and its subdirectories.

Parameters:

creation_info (Union[IResolvable, CreationInfoProperty, Dict[str, Any], None]) – (Optional) Specifies the POSIX IDs and permissions to apply to the access point’s RootDirectory . If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties. .. epigraph:: If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.
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. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-rootdirectory.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.mixins_preview.aws_efs import mixins as efs_mixins

root_directory_property = efs_mixins.CfnAccessPointPropsMixin.RootDirectoryProperty(
    creation_info=efs_mixins.CfnAccessPointPropsMixin.CreationInfoProperty(
        owner_gid="ownerGid",
        owner_uid="ownerUid",
        permissions="permissions"
    ),
    path="path"
)

Attributes

creation_info

(Optional) Specifies the POSIX IDs and permissions to apply to the access point’s RootDirectory .

If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties. .. epigraph:

If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` > ``Path`` does not exist, attempts to mount the file system using the access point will fail.

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

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.

A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .

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