Class CfnProject.ProjectFileSystemLocationProperty

Information about a file system created by Amazon Elastic File System (EFS).

Inheritance

System.Object

CfnProject.ProjectFileSystemLocationProperty

Implements

CfnProject.IProjectFileSystemLocationProperty

Namespace: Amazon.CDK.AWS.CodeBuild

Assembly: Amazon.CDK.AWS.CodeBuild.dll

Syntax (csharp)

public class ProjectFileSystemLocationProperty : Object, CfnProject.IProjectFileSystemLocationProperty

Syntax (vb)

Public Class ProjectFileSystemLocationProperty
    Inherits Object
    Implements CfnProject.IProjectFileSystemLocationProperty

Remarks

For more information, see What Is Amazon Elastic File System?

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.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.CodeBuild;

var projectFileSystemLocationProperty = new ProjectFileSystemLocationProperty {
    Identifier = "identifier",
    Location = "location",
    MountPoint = "mountPoint",
    Type = "type",

    // the properties below are optional
    MountOptions = "mountOptions"
};

Synopsis

Constructors

ProjectFileSystemLocationProperty()

Properties

Identifier	The name used to access a file system created by Amazon EFS.
Location	A string that specifies the location of the file system created by Amazon EFS.
MountOptions	The mount options for a file system created by Amazon EFS.
MountPoint	The location in the container where you mount the file system.
Type	The type of the file system.

Constructors

ProjectFileSystemLocationProperty()

public ProjectFileSystemLocationProperty()

Properties

Identifier

The name used to access a file system created by Amazon EFS.

public string Identifier { get; set; }

Property Value

System.String

Remarks

CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_ . For example, if you specify my_efs for identifier , a new environment variable is create named CODEBUILD_MY_EFS .

The identifier is used to mount your file system.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-identifier

Location

A string that specifies the location of the file system created by Amazon EFS.

public string Location { get; set; }

Property Value

System.String

Remarks

Its format is efs-dns-name:/directory-path . You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com , and its mount directory is my-efs-mount-directory , then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory .

The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-location

MountOptions

The mount options for a file system created by Amazon EFS.

public string MountOptions { get; set; }

Property Value

System.String

Remarks

The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2 . For more information, see Recommended NFS Mount Options .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountoptions

MountPoint

The location in the container where you mount the file system.

public string MountPoint { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountpoint

Type

The type of the file system.

public string Type { get; set; }

Property Value

System.String

Remarks

The one supported type is EFS .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-type

Implements

CfnProject.IProjectFileSystemLocationProperty