software.amazon.awscdk.services.efs

Class CfnAccessPoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.efs.CfnAccessPoint

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.850Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAccessPoint.AccessPointTagProperty A tag is a key-value pair attached to a file system.
static class	CfnAccessPoint.Builder A fluent builder for CfnAccessPoint.
static interface	CfnAccessPoint.CreationInfoProperty Required if the `RootDirectory` > `Path` specified does not exist.
static interface	CfnAccessPoint.PosixUserProperty 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.
static interface	CfnAccessPoint.RootDirectoryProperty Specifies the directory on the Amazon EFS file system that the access point provides access to.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAccessPoint(software.constructs.Construct scope, String id, CfnAccessPointProps props) Create a new `AWS::EFS::AccessPoint`.
protected	CfnAccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAccessPoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAccessPointTags() An array of key-value pairs to apply to this resource.
String	getAttrAccessPointId() The ID of the EFS access point.
String	getAttrArn() The Amazon Resource Name (ARN) of the access point.
protected Map<String,Object>	getCfnProperties()
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.
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.
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessPointTags(IResolvable value) An array of key-value pairs to apply to this resource.
void	setAccessPointTags(List<Object> value) An array of key-value pairs to apply to this resource.
void	setClientToken(String value) The opaque string specified in the request to ensure idempotent creation.
void	setFileSystemId(String value) The ID of the EFS file system that the access point applies to.
void	setPosixUser(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.
void	setPosixUser(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.
void	setRootDirectory(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.
void	setRootDirectory(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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAccessPoint

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

CfnAccessPoint

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

CfnAccessPoint

@Stability(value=Stable)
public CfnAccessPoint(@NotNull
                                               software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrAccessPointId()

The ID of the EFS access point.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the access point.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFileSystemId

@Stability(value=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(value=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(value=Stable)
 @Nullable
public Object getAccessPointTags()

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

For more information, see Tag .

setAccessPointTags

@Stability(value=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(value=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(value=Stable)
 @Nullable
public String getClientToken()

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

setClientToken

@Stability(value=Stable)
public void setClientToken(@Nullable
                                                    String value)

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

getPosixUser

@Stability(value=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(value=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.

setPosixUser

@Stability(value=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.

getRootDirectory

@Stability(value=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(value=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.

setRootDirectory

@Stability(value=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.