AccessPoint¶
-
class
aws_cdk.aws_efs.
AccessPoint
(scope, id, *, file_system, create_acl=None, path=None, posix_user=None)¶ Bases:
aws_cdk.core.Resource
(experimental) Represents the AccessPoint.
- Stability
experimental
- Parameters
scope (
Construct
) –id (
str
) –file_system (
IFileSystem
) – (experimental) The efs filesystem.create_acl (
Optional
[Acl
]) – (experimental) Specifies the POSIX IDs and permissions to apply when creating the access point’s root directory. If the root directory specified bypath
does not exist, EFS creates the root directory and applies the permissions specified here. If the specifiedpath
does not exist, you must specifycreateAcl
. Default: - None. The directory specified bypath
must exist.path (
Optional
[str
]) – (experimental) 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
]) – (experimental) 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
- Stability
experimental
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
¶ (experimental) The ARN of the Access Point.
- Stability
experimental
- Attribute
true
- Return type
str
-
access_point_id
¶ (experimental) The ID of the Access Point.
- Stability
experimental
- 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
-
file_system
¶ (experimental) The file system of the access point.
- Stability
experimental
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
from_access_point_attributes
(scope, id, *, access_point_arn=None, access_point_id=None, file_system=None)¶ (experimental) Import an existing Access Point by attributes.
- Parameters
scope (
Construct
) –id (
str
) –access_point_arn (
Optional
[str
]) – (experimental) The ARN of the AccessPoint One of this, or {@link accessPointId} is required. Default: - determined based on accessPointIdaccess_point_id (
Optional
[str
]) – (experimental) The ID of the AccessPoint One of this, or {@link accessPointArn} is required. Default: - determined based on accessPointArnfile_system (
Optional
[IFileSystem
]) – (experimental) The EFS file system. Default: - no EFS file system
- Stability
experimental
- Return type
-
classmethod
from_access_point_id
(scope, id, access_point_id)¶ (experimental) Import an existing Access Point by id.
- Parameters
scope (
Construct
) –id (
str
) –access_point_id (
str
) –
- Stability
experimental
- Return type
-
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