interface ProjectFileSystemLocationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CodeBuild.CfnProject.ProjectFileSystemLocationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#CfnProject_ProjectFileSystemLocationProperty |
 Java | software.amazon.awscdk.services.codebuild.CfnProject.ProjectFileSystemLocationProperty |
 Python | aws_cdk.aws_codebuild.CfnProject.ProjectFileSystemLocationProperty |
 TypeScript | aws-cdk-lib » aws_codebuild » CfnProject » ProjectFileSystemLocationProperty |
Information about a file system created by Amazon Elastic File System (EFS).
For more information, see What Is Amazon Elastic File System?
Example
// 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',
};
Properties
| Name | Type | Description |
|---|---|---|
| identifier | string | The name used to access a file system created by Amazon EFS. |
| location | string | A string that specifies the location of the file system created by Amazon EFS. |
| mount | string | The location in the container where you mount the file system. |
| type | string | The type of the file system. |
| mount | string | The mount options for a file system created by Amazon EFS. |
identifier
Type:
string
The name used to access a file system created by Amazon EFS.
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.
location
Type:
string
A string that specifies the location of the file system created by Amazon EFS.
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.
mountPoint
Type:
string
The location in the container where you mount the file system.
type
Type:
string
The type of the file system.
The one supported type is EFS .
mountOptions?
Type:
string
(optional)
The mount options for a file system created by Amazon EFS.
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 .