# CodePipelineVfsBinding

A file system (VFS) a code pipeline declares for its agents. It is stored with the pipeline, but a run mounts only the file systems in its own `vfsMounts`.

**Kind:** an object, used in requests and responses. In a request it is called `CodePipelineVfsBindingInput`.

## In a request

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | `string` |  | The name the file system is known by. |
| `vfsId` | `uuid \| null` |  | The file system's id, or null when none is named. |
| `mode` | [`CodePipelineVfsMode`](https://docs.maitento.com/reference/types/code-pipeline-vfs-mode.md) |  | Whether the agents may change the file system or only read it. |
| `context` | `string \| null` |  | A description of what the file system holds. |

```json
{
  "name": "...",
  "vfsId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "mode": "ReadOnly",
  "context": "..."
}
```

## In a response

Every field is present in a response; empty ones are `null`.

| Field | Type | Description |
|---|---|---|
| `name` | `string` | The name the file system is known by. |
| `vfsId` | `uuid \| null` | The file system's id, or null when none is named. |
| `mode` | [`CodePipelineVfsMode`](https://docs.maitento.com/reference/types/code-pipeline-vfs-mode.md) | Whether the agents may change the file system or only read it. |
| `context` | `string \| null` | A description of what the file system holds. |

```json
{
  "name": "...",
  "vfsId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "mode": "ReadOnly",
  "context": "..."
}
```

## Where it's used

- Inside [`CodePipelineCreateRequest`](https://docs.maitento.com/reference/types/code-pipeline-create-request.md)
- Inside [`CodePipelineUpdateRequest`](https://docs.maitento.com/reference/types/code-pipeline-update-request.md)
- Inside [`CodePipelineVersion`](https://docs.maitento.com/reference/types/code-pipeline-version.md)