Cloudflare/images
@swamp/cloudflare/imagesv2026.07.21.1
01README
Cloudflare images infrastructure models
02Release Notes
- Updated: variants
- Updated: migrations
- Updated: sources
03Models
@swamp/cloudflare/images/migrationsv2026.07.21.1migrations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| conflictBehaviour? | enum | How to handle objects that already exist at the destination. |
| excludedContentTypes? | array | Content types to skip during migration. |
| pathPrefix? | string | Prefix to prepend to image custom IDs. |
| rootDirectory? | string | Only import objects under this prefix in the source bucket. |
| sourceId | string | The identifier of the source to migrate from. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Migrations
fn get(id: string)
Get a Migrations
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Migrations |
fn lookup()
Look up an existing Migrations by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Migrations by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Migrations to import |
fn delete(id: string)
Delete the Migrations
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Migrations |
fn sync(identifier?: string)
Sync Migrations state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Migrations by id (e.g. one discovered by list) |
Resources
state(infinite)— Migrations resource state
@swamp/cloudflare/images/sourcesv2026.07.21.1sources.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | A human-readable name for the source. |
| account? | string | Account identifier for the bucket (required for R2 vendor). |
| bucket | string | The name of the storage bucket. |
| secret | record | Storage credentials for accessing the bucket. Shape depends on vendor. |
| vendor | enum | The cloud storage vendor of the source bucket. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Sources
fn get(id: string)
Get a Sources
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Sources |
fn lookup()
Look up an existing Sources by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Sources by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Sources to import |
fn update(identifier?: string)
Update Sources attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Sources by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Sources
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Sources |
fn sync(identifier?: string)
Sync Sources state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Sources by id (e.g. one discovered by list) |
Resources
state(infinite)— Sources resource state
@swamp/cloudflare/images/variantsv2026.07.21.1variants.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| neverRequireSignedURLs? | boolean | Indicates whether the variant can access an image without a signature, regardless of image access control. |
| options | object | Allows you to define image resizing sizes for different use cases. |
| id | string | |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Variants
fn get(id: string)
Get a Variants
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Variants |
fn lookup()
Look up an existing Variants by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Variants by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Variants to import |
fn update(identifier?: string)
Update Variants attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Variants by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Variants
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Variants |
fn sync(identifier?: string)
Sync Variants state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Variants by id (e.g. one discovered by list) |
Resources
state(infinite)— Variants resource state
04Previous Versions
2026.07.18.2
Modified 3 models
2026.07.14.1
- Added: migrations
- Added: sources
Added 2 models
2026.06.08.2
- Updated: variants
2026.05.29.1
- Updated: variants
2026.05.22.1
- Added: variants
05Stats
A
100 / 100
Downloads
0
Archive size
17.4 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels