Package software.amazon.awscdk.services.efs

Class CfnAccessPoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.efs.CfnAccessPoint
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.114Z") @Stability(Stable) public class CfnAccessPoint extends CfnResource implements IInspectable
A CloudFormation AWS::EFS::AccessPoint.

The AWS::EFS::AccessPoint resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see Mounting a file system using EFS access points .

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.efs.*;
 CfnAccessPoint cfnAccessPoint = CfnAccessPoint.Builder.create(this, "MyCfnAccessPoint")
         .fileSystemId("fileSystemId")
         // the properties below are optional
         .accessPointTags(List.of(AccessPointTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .clientToken("clientToken")
         .posixUser(PosixUserProperty.builder()
                 .gid("gid")
                 .uid("uid")
                 // the properties below are optional
                 .secondaryGids(List.of("secondaryGids"))
                 .build())
         .rootDirectory(RootDirectoryProperty.builder()
                 .creationInfo(CreationInfoProperty.builder()
                         .ownerGid("ownerGid")
                         .ownerUid("ownerUid")
                         .permissions("permissions")
                         .build())
                 .path("path")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAccessPoint

      protected CfnAccessPoint(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAccessPoint

      protected CfnAccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAccessPoint

      @Stability(Stable) public CfnAccessPoint(@NotNull Construct scope, @NotNull String id, @NotNull CfnAccessPointProps props)
      Create a new AWS::EFS::AccessPoint.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAccessPointId

      @Stability(Stable) @NotNull public String getAttrAccessPointId()
      The ID of the EFS access point.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the access point.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFileSystemId

      @Stability(Stable) @NotNull public String getFileSystemId()
      The ID of the EFS file system that the access point applies to.

      Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2 .

    • setFileSystemId

      @Stability(Stable) public void setFileSystemId(@NotNull String value)
      The ID of the EFS file system that the access point applies to.

      Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2 .

    • getAccessPointTags

      @Stability(Stable) @Nullable public Object getAccessPointTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • setAccessPointTags

      @Stability(Stable) public void setAccessPointTags(@Nullable IResolvable value)
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • setAccessPointTags

      @Stability(Stable) public void setAccessPointTags(@Nullable List<Object> value)
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getClientToken

      @Stability(Stable) @Nullable public String getClientToken()
      The opaque string specified in the request to ensure idempotent creation.

    • setClientToken

      @Stability(Stable) public void setClientToken(@Nullable String value)
      The opaque string specified in the request to ensure idempotent creation.

    • getPosixUser

      @Stability(Stable) @Nullable public Object getPosixUser()
      The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

    • setPosixUser

      @Stability(Stable) public void setPosixUser(@Nullable IResolvable value)
      The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

    • setPosixUser

      @Stability(Stable) public void setPosixUser(@Nullable CfnAccessPoint.PosixUserProperty value)
      The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

    • getRootDirectory

      @Stability(Stable) @Nullable public Object getRootDirectory()
      The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

    • setRootDirectory

      @Stability(Stable) public void setRootDirectory(@Nullable IResolvable value)
      The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

    • setRootDirectory

      @Stability(Stable) public void setRootDirectory(@Nullable CfnAccessPoint.RootDirectoryProperty value)
      The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.