Skip to content
v2.277.0

ProjectFileSystemLocationProperty Struct ​

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

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const projectFileSystemLocationProperty: codebuild.CfnProject.ProjectFileSystemLocationProperty = {
  identifier: 'identifier',
  location: 'location',
  mountPoint: 'mountPoint',
  type: 'type',

  // the properties below are optional
  mountOptions: 'mountOptions',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codebuild as codebuild

project_file_system_location_property = codebuild.CfnProject.ProjectFileSystemLocationProperty(
    identifier="identifier",
    location="location",
    mount_point="mountPoint",
    type="type",

    # the properties below are optional
    mount_options="mountOptions"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codebuild.*;

ProjectFileSystemLocationProperty projectFileSystemLocationProperty = ProjectFileSystemLocationProperty.builder()
        .identifier("identifier")
        .location("location")
        .mountPoint("mountPoint")
        .type("type")

        // the properties below are optional
        .mountOptions("mountOptions")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

projectFileSystemLocationProperty := &ProjectFileSystemLocationProperty{
	Identifier: jsii.String("identifier"),
	Location: jsii.String("location"),
	MountPoint: jsii.String("mountPoint"),
	Type: jsii.String("type"),

	// the properties below are optional
	MountOptions: jsii.String("mountOptions"),
}

Properties ​

identifierstringidentifierstridentifierStringIdentifierstringIdentifier*string required #
The name used to access a file system created by Amazon EFS.
notes

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.

locationstringlocationstrlocationStringLocationstringLocation*string required #
A string that specifies the location of the file system created by Amazon EFS.
notes

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.

mountOptionsoptionalstringmount_optionsoptionalstrmountOptionsoptionalStringMountOptionsoptionalstringMountOptionsoptional*string #
The mount options for a file system created by Amazon EFS.
notes

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 .

mountPointstringmount_pointstrmountPointStringMountPointstringMountPoint*string required #
The location in the container where you mount the file system.
typestringtypestrtypeStringTypestringType*string required #
The type of the file system.

The one supported type is EFS .