Package software.amazon.awscdk.services.efs

Interface CfnAccessPoint.CreationInfoProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccessPoint.CreationInfoProperty.Jsii$Proxy

Enclosing class:

CfnAccessPoint

@Stability(Stable)
public static interface CfnAccessPoint.CreationInfoProperty
extends software.amazon.jsii.JsiiSerializable

Required if the RootDirectory > Path specified does not exist.

Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory > Path . If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo , you must include values for all properties.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

If you do not provide CreationInfo and the specified RootDirectory does not exist, attempts to mount the file system using the access point will fail.

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.*;
 CreationInfoProperty creationInfoProperty = CreationInfoProperty.builder()
         .ownerGid("ownerGid")
         .ownerUid("ownerUid")
         .permissions("permissions")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAccessPoint.CreationInfoProperty.Builder	builder()
String	getOwnerGid()	Specifies the POSIX group ID to apply to the RootDirectory .
String	getOwnerUid()	Specifies the POSIX user ID to apply to the RootDirectory .
String	getPermissions()	Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file's mode bits.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOwnerGid

@Stability(Stable)
@NotNull
String getOwnerGid()

Specifies the POSIX group ID to apply to the RootDirectory .

Accepts values from 0 to 2^32 (4294967295).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-ownergid

getOwnerUid

@Stability(Stable)
@NotNull
String getOwnerUid()

Specifies the POSIX user ID to apply to the RootDirectory .

Accepts values from 0 to 2^32 (4294967295).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-owneruid

getPermissions

@Stability(Stable)
@NotNull
String getPermissions()

Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file's mode bits.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-creationinfo.html#cfn-efs-accesspoint-creationinfo-permissions

builder

@Stability(Stable)
static CfnAccessPoint.CreationInfoProperty.Builder builder()

Returns:

a CfnAccessPoint.CreationInfoProperty.Builder of CfnAccessPoint.CreationInfoProperty