Skip to main content

Cloudflare/images

@swamp/cloudflare/imagesv2026.10.23.1· AGPL-3.0-or-later· 2d agoBEHAVIORS
01README

Cloudflare images infrastructure models

02Release Notes
  • Updated: variants
  • Updated: migrations
  • Updated: sources
03Behaviors3
@swamp/cloudflare/images/migrationsv2026.10.23.1migrations.ts

Global Arguments

ArgumentTypeDescription
account_idstringCloudflare account ID
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
conflictBehaviour?enumHow to handle objects that already exist at the destination.
excludedContentTypes?arrayContent types to skip during migration.
pathPrefix?stringPrefix to prepend to image custom IDs.
rootDirectory?stringOnly import objects under this prefix in the source bucket.
sourceId?stringThe identifier of the source to migrate from.
apiToken?stringCloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?stringCloudflare 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?stringCloudflare 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
ArgumentTypeDescription
idstringThe ID of the Migrations
fn lookup(allowMissing?: boolean)
Look up an existing Migrations by matching global argument values and import it into state
ArgumentTypeDescription
allowMissing?booleanSucceed and record found: false in lookupResult when nothing matches, instead of failing
fn adopt(id: string)
Import an existing Migrations by ID into state for management
ArgumentTypeDescription
idstringThe ID of the Migrations to import
fn delete(id: string)
Delete the Migrations
ArgumentTypeDescription
idstringThe ID of the Migrations
fn sync(identifier?: string)
Sync Migrations state from Cloudflare
ArgumentTypeDescription
identifier?stringTarget a specific Migrations by id (e.g. one discovered by list)

Resources

state(infinite)— Migrations resource state
lookupResult(infinite)— Outcome of the most recent lookup
@swamp/cloudflare/images/sourcesv2026.10.23.1sources.ts

Global Arguments

ArgumentTypeDescription
account_idstringCloudflare account ID
name?stringA human-readable name for the source.
account?stringAccount identifier for the bucket (required for R2 vendor).
bucket?stringThe name of the storage bucket.
secret?recordStorage credentials for accessing the bucket. Shape depends on vendor.
vendor?enumThe cloud storage vendor of the source bucket.
apiToken?stringCloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?stringCloudflare 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?stringCloudflare 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
ArgumentTypeDescription
idstringThe ID of the Sources
fn lookup(allowMissing?: boolean)
Look up an existing Sources by matching global argument values and import it into state
ArgumentTypeDescription
allowMissing?booleanSucceed and record found: false in lookupResult when nothing matches, instead of failing
fn adopt(id: string)
Import an existing Sources by ID into state for management
ArgumentTypeDescription
idstringThe ID of the Sources to import
fn update(identifier?: string)
Update Sources attributes
ArgumentTypeDescription
identifier?stringTarget a specific Sources by id (e.g. one discovered by list)
fn delete(id: string)
Delete the Sources
ArgumentTypeDescription
idstringThe ID of the Sources
fn sync(identifier?: string)
Sync Sources state from Cloudflare
ArgumentTypeDescription
identifier?stringTarget a specific Sources by id (e.g. one discovered by list)

Resources

state(infinite)— Sources resource state
lookupResult(infinite)— Outcome of the most recent lookup
@swamp/cloudflare/images/variantsv2026.10.23.1variants.ts

Global Arguments

ArgumentTypeDescription
account_idstringCloudflare account ID
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
neverRequireSignedURLs?booleanIndicates whether the variant can access an image without a signature, regardless of image access control.
options?objectAllows you to define image resizing sizes for different use cases.
id?string
apiToken?stringCloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
apiKey?stringCloudflare 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?stringCloudflare 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
ArgumentTypeDescription
idstringThe ID of the Variants
fn lookup(allowMissing?: boolean)
Look up an existing Variants by matching global argument values and import it into state
ArgumentTypeDescription
allowMissing?booleanSucceed and record found: false in lookupResult when nothing matches, instead of failing
fn adopt(id: string)
Import an existing Variants by ID into state for management
ArgumentTypeDescription
idstringThe ID of the Variants to import
fn update(identifier?: string)
Update Variants attributes
ArgumentTypeDescription
identifier?stringTarget a specific Variants by id (e.g. one discovered by list)
fn delete(id: string)
Delete the Variants
ArgumentTypeDescription
idstringThe ID of the Variants
fn sync(identifier?: string)
Sync Variants state from Cloudflare
ArgumentTypeDescription
identifier?stringTarget a specific Variants by id (e.g. one discovered by list)

Resources

state(infinite)— Variants resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions13
2026.10.20.1AGPL-3.0-or-later
  • Updated: variants
  • Updated: migrations
  • Updated: sources

Modified 3 behaviors

2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
  • Updated: variants
  • Updated: migrations
  • Updated: sources
2026.09.29.1
  • Updated: variants
  • Updated: migrations
  • Updated: sources
2026.09.25.1
  • Updated: variants
2026.08.25.2
  • Added: migrations
  • Added: sources

Added 2 behaviors

2026.08.25.1

Removed 2 behaviors

2026.07.21.1
  • Updated: variants
  • Updated: migrations
  • Updated: sources
2026.07.18.2

Modified 3 behaviors

2026.07.14.1
  • Added: migrations
  • Added: sources

Added 2 behaviors

2026.06.08.2
  • Updated: variants
2026.05.29.1
  • Updated: variants
2026.05.22.1
  • Added: variants
05Stats
A
100 / 100
Downloads
25
Archive size
16.1 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
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels