Package software.amazon.awscdk.services.efs

Interface CfnAccessPointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccessPointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-17T05:10:10.665Z")
@Stability(Stable)
public interface CfnAccessPointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAccessPoint.

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.*;
 CfnAccessPointProps cfnAccessPointProps = CfnAccessPointProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAccessPointProps.Builder	A builder for CfnAccessPointProps
static final class	CfnAccessPointProps.Jsii$Proxy	An implementation for CfnAccessPointProps

Method Summary

Modifier and Type	Method	Description
static CfnAccessPointProps.Builder	builder()
default List<CfnAccessPoint.AccessPointTagProperty>	getAccessPointTags()	An array of key-value pairs to apply to this resource.
default String	getClientToken()	The opaque string specified in the request to ensure idempotent creation.
String	getFileSystemId()	The ID of the EFS file system that the access point applies to.
default 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.
default Object	getRootDirectory()	The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFileSystemId

@Stability(Stable)
@NotNull
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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-filesystemid

getAccessPointTags

@Stability(Stable)
@Nullable
default List<CfnAccessPoint.AccessPointTagProperty> getAccessPointTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-accesspointtags

getClientToken

@Stability(Stable)
@Nullable
default String getClientToken()

The opaque string specified in the request to ensure idempotent creation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-clienttoken

getPosixUser

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-posixuser

getRootDirectory

@Stability(Stable)
@Nullable
default Object getRootDirectory()

The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-rootdirectory

builder

@Stability(Stable)
static CfnAccessPointProps.Builder builder()

Returns:

a CfnAccessPointProps.Builder of CfnAccessPointProps