Skip to content

ProjectFileSystemLocation

Source code in docs_src/capo_codebuild/types/project_file_system_location.py 
12
13
14
15
16
17
18
19
20
21
22
class ProjectFileSystemLocation(TypedDict, closed=True):
    type: NotRequired["capo_codebuild.types.file_system_type.FileSystemType"]
    """<p> The type of the file system. The one supported type is <code>EFS</code>. </p>"""
    location: NotRequired["capo_codebuild.types.string.String"]
    """<p>A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. 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 <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>"""
    mount_point: NotRequired["capo_codebuild.types.string.String"]
    """<p>The location in the container where you mount the file system. </p>"""
    identifier: NotRequired["capo_codebuild.types.string.String"]
    """<p>The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY_EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>"""
    mount_options: NotRequired["capo_codebuild.types.string.String"]
    """<p> The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are <code>nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2</code>. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html">Recommended NFS Mount Options</a>. </p>"""

identifier instance-attribute 

identifier: NotRequired[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 instance-attribute 

location: NotRequired[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.

mount_options instance-attribute 

mount_options: NotRequired[String]

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.

mount_point instance-attribute 

mount_point: NotRequired[String]

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

type instance-attribute 

type: NotRequired[FileSystemType]

The type of the file system. The one supported type is EFS.