AccessPoint

class aws_cdk.aws_efs.AccessPoint(scope, id, *, file_system, create_acl=None, path=None, posix_user=None)

Bases: aws_cdk.core.Resource

Represents the AccessPoint.

Parameters

  • scope (Construct) –

  • id (str) –

  • file_system (IFileSystem) – The efs filesystem.

  • create_acl (Optional[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.

  • 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 (Optional[PosixUser]) – 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

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

access_point_arn

The ARN of the Access Point.

Attribute

true

Return type

str

access_point_id

The ID of the Access Point.

Attribute

true

Return type

str

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

file_system

The file system of the access point.

Return type

IFileSystem

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_access_point_attributes(scope, id, *, access_point_arn=None, access_point_id=None, file_system=None)

Import an existing Access Point by attributes.

Parameters

  • scope (Construct) –

  • id (str) –

  • access_point_arn (Optional[str]) – The ARN of the AccessPoint One of this, or {@link accessPointId} is required. Default: - determined based on accessPointId

  • access_point_id (Optional[str]) – The ID of the AccessPoint One of this, or {@link accessPointArn} is required. Default: - determined based on accessPointArn

  • file_system (Optional[IFileSystem]) – The EFS file system. Default: - no EFS file system

Return type

IAccessPoint

classmethod from_access_point_id(scope, id, access_point_id)

Import an existing Access Point by id.

Parameters

  • scope (Construct) –

  • id (str) –

  • access_point_id (str) –

Return type

IAccessPoint

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool