55 lines
1.3 KiB
Markdown
55 lines
1.3 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "immich_library Resource - immich"
|
|
subcategory: ""
|
|
description: |-
|
|
Manages an Immich library.
|
|
---
|
|
|
|
# immich_library (Resource)
|
|
|
|
Manages an Immich library.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "immich_library" "external" {
|
|
name = "My External Photos"
|
|
type = "EXTERNAL"
|
|
import_paths = [
|
|
"/mnt/photos/vacation_2023",
|
|
"/mnt/photos/family"
|
|
]
|
|
exclusion_patterns = [
|
|
"**/tmp/**",
|
|
"**/.DS_Store"
|
|
]
|
|
is_visible = true
|
|
}
|
|
|
|
resource "immich_library" "upload" {
|
|
name = "Personal Uploads"
|
|
type = "UPLOAD"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `name` (String) Display name of the library.
|
|
- `type` (String) Type of the library. Must be either `UPLOAD` or `EXTERNAL`.
|
|
|
|
### Optional
|
|
|
|
- `exclusion_patterns` (List of String) List of glob patterns to exclude from import.
|
|
- `import_paths` (List of String) List of filesystem paths to import assets from (required for `EXTERNAL` libraries).
|
|
- `is_visible` (Boolean) Whether the library is visible in the UI.
|
|
|
|
### Read-Only
|
|
|
|
- `asset_count` (Number) Number of assets currently in the library.
|
|
- `id` (String) Unique identifier for the library.
|
|
- `owner_id` (String) Unique identifier of the library owner.
|