ProjectFileSystemLocation
Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
Contents
Note
In the following list, the required parameters are described first.
- identifier
-
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 toCODEBUILD_
. For example, if you specifymy_efs
foridentifier
, a new environment variable is create namedCODEBUILD_MY_EFS
.The
identifier
is used to mount your file system.Type: String
Required: No
- location
-
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 isfs-abcd1234.efs.us-west-2.amazonaws.com
, and its mount directory ismy-efs-mount-directory
, then thelocation
isfs-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.Type: String
Required: No
- mountOptions
-
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.Type: String
Required: No
- mountPoint
-
The location in the container where you mount the file system.
Type: String
Required: No
- type
-
The type of the file system. The one supported type is
EFS
.Type: String
Valid Values:
EFS
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: