AWS CDK Reference

Appearance

v2.274.0

AccessPoint L2 construct ​

Represents the AccessPoint.

CloudFormation
AWS::EFS::AccessPoint
L1 type
CfnAccessPoint
Source
aws-efs/lib/access-point.ts
Type last changed
v2.234.0 · 8 Jan 2026

Example ​

ts
efs.AccessPoint.fromAccessPointAttributes(this, 'ap', {
  accessPointId: 'fsap-1293c4d9832fo0912',
  fileSystem: efs.FileSystem.fromFileSystemAttributes(this, 'efs', {
    fileSystemId: 'fs-099d3e2f',
    securityGroup: ec2.SecurityGroup.fromSecurityGroupId(this, 'sg', 'sg-51530134'),
  }),
});
python
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")
    )
)
java
AccessPoint.fromAccessPointAttributes(this, "ap", AccessPointAttributes.builder()
        .accessPointId("fsap-1293c4d9832fo0912")
        .fileSystem(FileSystem.fromFileSystemAttributes(this, "efs", FileSystemAttributes.builder()
                .fileSystemId("fs-099d3e2f")
                .securityGroup(SecurityGroup.fromSecurityGroupId(this, "sg", "sg-51530134"))
                .build()))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
AccessPoint.FromAccessPointAttributes(this, "ap", new AccessPointAttributes {
    AccessPointId = "fsap-1293c4d9832fo0912",
    FileSystem = FileSystem.FromFileSystemAttributes(this, "efs", new FileSystemAttributes {
        FileSystemId = "fs-099d3e2f",
        SecurityGroup = SecurityGroup.FromSecurityGroupId(this, "sg", "sg-51530134")
    })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
efs.AccessPoint_FromAccessPointAttributes(this, jsii.String("ap"), &AccessPointAttributes{
	AccessPointId: jsii.String("fsap-1293c4d9832fo0912"),
	FileSystem: efs.FileSystem_FromFileSystemAttributes(this, jsii.String("efs"), &FileSystemAttributes{
		FileSystemId: jsii.String("fs-099d3e2f"),
		SecurityGroup: ec2.SecurityGroup_FromSecurityGroupId(this, jsii.String("sg"), jsii.String("sg-51530134")),
	}),
})

Initializer ​

ts
new AccessPoint(scope: Construct, id: string, props: AccessPointProps)
python
AccessPoint(scope: Construct, id: str, props: AccessPointProps)
java
new AccessPoint(Construct scope, String id, AccessPointProps props)
csharp
new AccessPoint(Construct scope, string id, AccessPointProps props)
go
NewAccessPoint(Scope Construct, Id *string, Props AccessPointProps)

Construct Props ​

clientTokenstringclient_tokenstrclientTokenStringClientTokenstringClientToken*string= No client token#
The opaque string specified in the request to ensure idempotent creation.
createAclAclcreate_aclAclcreateAclAclCreateAclAclCreateAclAcl= None. The directory specified by…#
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

Default: None. The directory specified by path must exist.

fileSystemIFileSystemReffile_systemIFileSystemReffileSystemIFileSystemRefFileSystemIFileSystemRefFileSystemIFileSystemRefrequired#
The efs filesystem.
pathstringpathstrpathStringPathstringPath*string= '/'#
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.
posixUserPosixUserposix_userPosixUserposixUserPosixUserPosixUserPosixUserPosixUserPosixUser= user identity not enforced#
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.

Properties ​

accessPointArnstringaccess_point_arnstraccessPointArnStringAccessPointArnstringAccessPointArn*stringrequired#
The ARN of the Access Point.
accessPointIdstringaccess_point_idstraccessPointIdStringAccessPointIdstringAccessPointId*stringrequired#
The ID of the Access Point.
accessPointRefAccessPointReferenceaccess_point_refAccessPointReferenceaccessPointRefAccessPointReferenceAccessPointRefAccessPointReferenceAccessPointRefAccessPointReferencerequired#
A reference to a AccessPoint resource.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

fileSystemIFileSystemfile_systemIFileSystemfileSystemIFileSystemFileSystemIFileSystemFileSystemIFileSystemrequired#
The file system of the access point.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#
Uniquely identifies this class.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Override the cross-stack reference strength for this resource.
notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

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

fromAccessPointAttributes(scope: Construct, id: string, attrs: AccessPointAttributes): IAccessPoint@staticmethod def from_access_point_attributes(scope: Construct, id: str, attrs: AccessPointAttributes) -> IAccessPointpublic static IAccessPoint fromAccessPointAttributes(Construct scope, String id, AccessPointAttributes attrs)public static IAccessPoint FromAccessPointAttributes(Construct scope, string id, AccessPointAttributes attrs)func FromAccessPointAttributes(Scope Construct, Id *string, Attrs AccessPointAttributes) IAccessPointstatic#
Import an existing Access Point by attributes.
fromAccessPointId(scope: Construct, id: string, accessPointId: string): IAccessPoint@staticmethod def from_access_point_id(scope: Construct, id: str, access_point_id: str) -> IAccessPointpublic static IAccessPoint fromAccessPointId(Construct scope, String id, String accessPointId)public static IAccessPoint FromAccessPointId(Construct scope, string id, string accessPointId)func FromAccessPointId(Scope Construct, Id *string, AccessPointId *string) IAccessPointstatic#
Import an existing Access Point by id.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

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

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#
Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#
Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.