AccessPoint

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

Bases: Resource

Represents the AccessPoint.

ExampleMetadata:: infused

Example:

efs.AccessPoint.from_access_point_attributes(self, "ap",
    access_point_id="fsap-1293c4d9832fo0912",
    file_system=efs.FileSystem.from_file_system_attributes(self, "efs",
        file_system_id="fs-099d3e2f",
        security_group=ec2.SecurityGroup.from_security_group_id(self, "sg", "sg-51530134")
    )
)

Parameters:

scope (Construct) –
id (str) –
file_system (IFileSystem) – The efs filesystem.
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

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.DESTROY), 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

access_point_id

The ID of the Access Point.

Attribute:: true

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.

file_system: The file system of the access point.

node: The tree node.

stack: The stack in which this resource is defined.

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 accessPointId is required. Default: - determined based on accessPointId
access_point_id (Optional[str]) – The ID of the AccessPoint One of this, or 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)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool