CfnAccessPointPropsMixin

class aws_cdk.cfn_property_mixins.aws_s3files.CfnAccessPointPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::S3Files::AccessPoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html
CloudformationResource:: AWS::S3Files::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.cfn_property_mixins import aws_s3files as s3files
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_access_point_props_mixin = s3files.CfnAccessPointPropsMixin(s3files.CfnAccessPointMixinProps(
    client_token="clientToken",
    file_system_id="fileSystemId",
    posix_user=s3files.CfnAccessPointPropsMixin.PosixUserProperty(
        gid="gid",
        secondary_gids=["secondaryGids"],
        uid="uid"
    ),
    root_directory=s3files.CfnAccessPointPropsMixin.RootDirectoryProperty(
        creation_permissions=s3files.CfnAccessPointPropsMixin.CreationPermissionsProperty(
            owner_gid="ownerGid",
            owner_uid="ownerUid",
            permissions="permissions"
        ),
        path="path"
    ),
    tags=[s3files.CfnAccessPointPropsMixin.AccessPointTagProperty(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

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

Static Methods

classmethod is_mixin(x)

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.

AccessPointTagProperty

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

Bases: object

Parameters:

key (Optional[str])
value (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-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.cfn_property_mixins import aws_s3files as s3files

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

Attributes

key

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

Type:: see

value

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

Type:: see

CreationPermissionsProperty

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

Bases: object

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-s3files-accesspoint-creationpermissions.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.cfn_property_mixins import aws_s3files as s3files

creation_permissions_property = s3files.CfnAccessPointPropsMixin.CreationPermissionsProperty(
    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-s3files-accesspoint-creationpermissions.html#cfn-s3files-accesspoint-creationpermissions-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-s3files-accesspoint-creationpermissions.html#cfn-s3files-accesspoint-creationpermissions-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-s3files-accesspoint-creationpermissions.html#cfn-s3files-accesspoint-creationpermissions-permissions

PosixUserProperty

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

Bases: object

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-s3files-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.cfn_property_mixins import aws_s3files as s3files

posix_user_property = s3files.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-s3files-accesspoint-posixuser.html#cfn-s3files-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-s3files-accesspoint-posixuser.html#cfn-s3files-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-s3files-accesspoint-posixuser.html#cfn-s3files-accesspoint-posixuser-uid

RootDirectoryProperty

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

Bases: object

Parameters:

creation_permissions (Union[IResolvable, CreationPermissionsProperty, Dict[str, Any], None])
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 CreationPermissions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-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.cfn_property_mixins import aws_s3files as s3files

root_directory_property = s3files.CfnAccessPointPropsMixin.RootDirectoryProperty(
    creation_permissions=s3files.CfnAccessPointPropsMixin.CreationPermissionsProperty(
        owner_gid="ownerGid",
        owner_uid="ownerUid",
        permissions="permissions"
    ),
    path="path"
)

Attributes

creation_permissions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-rootdirectory.html#cfn-s3files-accesspoint-rootdirectory-creationpermissions

Type:: see

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 CreationPermissions.

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