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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.387Z")
 @Stability(value=Stable)
public class CfnAccessPoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EFS::AccessPoint`.

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 Example:
static class	CfnAccessPoint.Builder A fluent builder for CfnAccessPoint.
static interface	CfnAccessPoint.CreationInfoProperty Example:
static interface	CfnAccessPoint.PosixUserProperty Example:
static interface	CfnAccessPoint.RootDirectoryProperty Example:

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() `AWS::EFS::AccessPoint.AccessPointTags`.
String	getAttrAccessPointId()
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
String	getClientToken() `AWS::EFS::AccessPoint.ClientToken`.
String	getFileSystemId() `AWS::EFS::AccessPoint.FileSystemId`.
Object	getPosixUser() `AWS::EFS::AccessPoint.PosixUser`.
Object	getRootDirectory() `AWS::EFS::AccessPoint.RootDirectory`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessPointTags(IResolvable value) `AWS::EFS::AccessPoint.AccessPointTags`.
void	setAccessPointTags(List<Object> value) `AWS::EFS::AccessPoint.AccessPointTags`.
void	setClientToken(String value) `AWS::EFS::AccessPoint.ClientToken`.
void	setFileSystemId(String value) `AWS::EFS::AccessPoint.FileSystemId`.
void	setPosixUser(CfnAccessPoint.PosixUserProperty value) `AWS::EFS::AccessPoint.PosixUser`.
void	setPosixUser(IResolvable value) `AWS::EFS::AccessPoint.PosixUser`.
void	setRootDirectory(CfnAccessPoint.RootDirectoryProperty value) `AWS::EFS::AccessPoint.RootDirectory`.
void	setRootDirectory(IResolvable value) `AWS::EFS::AccessPoint.RootDirectory`.

Methods inherited from class software.amazon.awscdk.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.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.

getAccessPointTags

@Stability(value=Stable)
 @Nullable
public Object getAccessPointTags()

`AWS::EFS::AccessPoint.AccessPointTags`.

setAccessPointTags

@Stability(value=Stable)
public void setAccessPointTags(@Nullable
                                                        IResolvable value)

`AWS::EFS::AccessPoint.AccessPointTags`.

setAccessPointTags

@Stability(value=Stable)
public void setAccessPointTags(@Nullable
                                                        List<Object> value)

`AWS::EFS::AccessPoint.AccessPointTags`.

getAttrAccessPointId

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

getAttrArn

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getClientToken

@Stability(value=Stable)
 @Nullable
public String getClientToken()

`AWS::EFS::AccessPoint.ClientToken`.

setClientToken

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

`AWS::EFS::AccessPoint.ClientToken`.

getFileSystemId

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

`AWS::EFS::AccessPoint.FileSystemId`.

setFileSystemId

@Stability(value=Stable)
public void setFileSystemId(@NotNull
                                                     String value)

`AWS::EFS::AccessPoint.FileSystemId`.

getPosixUser

@Stability(value=Stable)
 @Nullable
public Object getPosixUser()

`AWS::EFS::AccessPoint.PosixUser`.

setPosixUser

@Stability(value=Stable)
public void setPosixUser(@Nullable
                                                  CfnAccessPoint.PosixUserProperty value)

`AWS::EFS::AccessPoint.PosixUser`.

setPosixUser

@Stability(value=Stable)
public void setPosixUser(@Nullable
                                                  IResolvable value)

`AWS::EFS::AccessPoint.PosixUser`.

getRootDirectory

@Stability(value=Stable)
 @Nullable
public Object getRootDirectory()

`AWS::EFS::AccessPoint.RootDirectory`.

setRootDirectory

@Stability(value=Stable)
public void setRootDirectory(@Nullable
                                                      CfnAccessPoint.RootDirectoryProperty value)

`AWS::EFS::AccessPoint.RootDirectory`.

setRootDirectory

@Stability(value=Stable)
public void setRootDirectory(@Nullable
                                                      IResolvable value)

`AWS::EFS::AccessPoint.RootDirectory`.