tf_provider_immich/docs/resources/library.md

page_title, subcategory, description

page_title	subcategory	description
immich_library Resource - immich		Manages an Immich library.

immich_library (Resource)

Manages an Immich library.

Example Usage

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

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.