Amazon CodeBuild · JSON Structure

Amazon Codebuild Project File System Location Structure

Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?

Type: object Properties: 5
AmazonCI/CDBuildContinuous IntegrationDevOpsTesting

ProjectFileSystemLocation is a JSON Structure definition published by Amazon CodeBuild, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type location mountPoint identifier mountOptions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/json-structure/amazon-codebuild-project-file-system-location-structure.json",
  "name": "ProjectFileSystemLocation",
  "description": " Information about a file system created by Amazon Elastic File System (EFS). For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html\">What Is Amazon Elastic File System?</a> ",
  "type": "object",
  "properties": {
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileSystemType"
        },
        {
          "description": " The type of the file system. The one supported type is <code>EFS</code>. "
        }
      ]
    },
    "location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "mountPoint": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The location in the container where you mount the file system. "
        }
      ]
    },
    "identifier": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "mountOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " 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>. "
        }
      ]
    }
  }
}