AWS::CodeBuild::Project ProjectFileSystemLocation
Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Identifier" :
String
, "Location" :String
, "MountOptions" :String
, "MountPoint" :String
, "Type" :String
}
YAML
Identifier:
String
Location:String
MountOptions:String
MountPoint:String
Type:String
Properties
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.Required: Yes
Type: String
Update requires: No interruption
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.Required: Yes
Type: String
Update requires: No interruption
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.Required: No
Type: String
Update requires: No interruption
MountPoint
-
The location in the container where you mount the file system.
Required: Yes
Type: String
Update requires: No interruption
Type
-
The type of the file system. The one supported type is
EFS
.Required: Yes
Type: String
Allowed values:
EFS
Update requires: No interruption