Class CfnAccessPoint
A CloudFormation AWS::EFS::AccessPoint
.
Inherited Members
Namespace: Amazon.CDK.AWS.EFS
Assembly: Amazon.CDK.AWS.EFS.dll
Syntax (csharp)
public class CfnAccessPoint : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAccessPoint
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::EFS::AccessPoint
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EFS;
var cfnAccessPoint = new CfnAccessPoint(this, "MyCfnAccessPoint", new CfnAccessPointProps {
FileSystemId = "fileSystemId",
// the properties below are optional
AccessPointTags = new [] { new AccessPointTagProperty {
Key = "key",
Value = "value"
} },
ClientToken = "clientToken",
PosixUser = new PosixUserProperty {
Gid = "gid",
Uid = "uid",
// the properties below are optional
SecondaryGids = new [] { "secondaryGids" }
},
RootDirectory = new RootDirectoryProperty {
CreationInfo = new CreationInfoProperty {
OwnerGid = "ownerGid",
OwnerUid = "ownerUid",
Permissions = "permissions"
},
Path = "path"
}
});
Synopsis
Constructors
CfnAccessPoint(Construct, String, ICfnAccessPointProps) | Create a new |
CfnAccessPoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAccessPoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AccessPointTags | An array of key-value pairs to apply to this resource. |
AttrAccessPointId | The ID of the EFS access point. |
AttrArn | The Amazon Resource Name (ARN) of the access point. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClientToken | The opaque string specified in the request to ensure idempotent creation. |
FileSystemId | The ID of the EFS file system that the access point applies to. |
PosixUser | 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. |
RootDirectory | 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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAccessPoint(Construct, String, ICfnAccessPointProps)
Create a new AWS::EFS::AccessPoint
.
public CfnAccessPoint(Construct scope, string id, ICfnAccessPointProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAccessPointProps
- resource properties.
CfnAccessPoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAccessPoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAccessPoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAccessPoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AccessPointTags
An array of key-value pairs to apply to this resource.
public virtual object AccessPointTags { get; set; }
Property Value
System.Object
Remarks
For more information, see Tag .
AttrAccessPointId
The ID of the EFS access point.
public virtual string AttrAccessPointId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AccessPointId
AttrArn
The Amazon Resource Name (ARN) of the access point.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientToken
The opaque string specified in the request to ensure idempotent creation.
public virtual string ClientToken { get; set; }
Property Value
System.String
Remarks
FileSystemId
The ID of the EFS file system that the access point applies to.
public virtual string FileSystemId { get; set; }
Property Value
System.String
Remarks
Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2
.
PosixUser
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.
public virtual object PosixUser { get; set; }
Property Value
System.Object
Remarks
RootDirectory
The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
public virtual object RootDirectory { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>