software.amazon.awscdk.services.efs

Class CfnAccessPoint

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.644Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAccessPoint(Construct scope, java.lang.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
java.lang.Object	getAccessPointTags() An array of key-value pairs to apply to this resource.
java.lang.String	getAttrAccessPointId() The ID of the EFS access point.
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the access point.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getClientToken() The opaque string specified in the request to ensure idempotent creation.
java.lang.String	getFileSystemId() The ID of the EFS file system that the access point applies to.
java.lang.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.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAccessPointTags(IResolvable value) An array of key-value pairs to apply to this resource.
void	setAccessPointTags(java.util.List<java.lang.Object> value) An array of key-value pairs to apply to this resource.
void	setClientToken(java.lang.String value) The opaque string specified in the request to ensure idempotent creation.
void	setFileSystemId(java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnAccessPoint(Construct scope,
                      java.lang.String id,
                      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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAccessPointId

public java.lang.String getAttrAccessPointId()

The ID of the EFS access point.

getAttrArn

public java.lang.String getAttrArn()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFileSystemId

public java.lang.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

public void setFileSystemId(java.lang.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

public java.lang.Object getAccessPointTags()

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

For more information, see Tag .

setAccessPointTags

public void setAccessPointTags(IResolvable value)

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

For more information, see Tag .

setAccessPointTags

public void setAccessPointTags(java.util.List<java.lang.Object> value)

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

For more information, see Tag .

getClientToken

public java.lang.String getClientToken()

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

setClientToken

public void setClientToken(java.lang.String value)

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

getPosixUser

public java.lang.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

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

setPosixUser

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

getRootDirectory

public java.lang.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

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

setRootDirectory

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