1# Cloudflare Pulumi Provider
2 
3Expert guidance for Cloudflare Pulumi Provider (@pulumi/cloudflare).
4 
5## Overview
6 
7Programmatic management of Cloudflare resources: Workers, Pages, D1, KV, R2, DNS, Queues, etc.
8 
9**Packages:**
10- TypeScript/JS: `@pulumi/cloudflare`
11- Python: `pulumi-cloudflare`
12- Go: `github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare`
13- .NET: `Pulumi.Cloudflare`
14 
15**Version:** v6.x
16 
17## Core Principles
18 
191. Use API tokens (not legacy API keys)
202. Store accountId in stack config
213. Match binding names across code/config
224. Use `module: true` for ES modules
235. Set `compatibilityDate` to lock behavior
24 
25## Authentication
26 
27```typescript
28import * as cloudflare from "@pulumi/cloudflare";
29 
30// API Token (recommended): CLOUDFLARE_API_TOKEN env
31const provider = new cloudflare.Provider("cf", { apiToken: process.env.CLOUDFLARE_API_TOKEN });
32 
33// API Key (legacy): CLOUDFLARE_API_KEY + CLOUDFLARE_EMAIL env
34const provider = new cloudflare.Provider("cf", { apiKey: process.env.CLOUDFLARE_API_KEY, email: process.env.CLOUDFLARE_EMAIL });
35 
36// API User Service Key: CLOUDFLARE_API_USER_SERVICE_KEY env
37const provider = new cloudflare.Provider("cf", { apiUserServiceKey: process.env.CLOUDFLARE_API_USER_SERVICE_KEY });
38```
39 
40## Setup
41 
42**Pulumi.yaml:**
43```yaml
44name: my-cloudflare-app
45runtime: nodejs
46config:
47  cloudflare:apiToken:
48    value: ${CLOUDFLARE_API_TOKEN}
49```
50 
51**Pulumi.<stack>.yaml:**
52```yaml
53config:
54  cloudflare:accountId: "abc123..."
55```
56 
57**index.ts:**
58```typescript
59import * as pulumi from "@pulumi/pulumi";
60import * as cloudflare from "@pulumi/cloudflare";
61const accountId = new pulumi.Config("cloudflare").require("accountId");
62```
63 
64## Common Resource Types
65- `Provider` - Provider config
66- `WorkerScript` - Worker
67- `WorkersKvNamespace` - KV
68- `R2Bucket` - R2
69- `D1Database` - D1
70- `Queue` - Queue
71- `PagesProject` - Pages
72- `DnsRecord` - DNS
73- `WorkerRoute` - Worker route
74- `WorkersDomain` - Custom domain
75 
76## Key Properties
77- `accountId` - Required for most resources
78- `zoneId` - Required for DNS/domain
79- `name`/`title` - Resource identifier
80- `*Bindings` - Connect resources to Workers
81 
82## Reading Order
83 
84| Order | File | What | When to Read |
85|-------|------|------|--------------|
86| 1 | [configuration.md](./configuration.md) | Resource config for Workers/KV/D1/R2/Queues/Pages | First time setup, resource reference |
87| 2 | [patterns.md](./patterns.md) | Architecture patterns, multi-env, component resources | Building complex apps, best practices |
88| 3 | [api.md](./api.md) | Outputs, dependencies, imports, dynamic providers | Advanced features, integrations |
89| 4 | [gotchas.md](./gotchas.md) | Common errors, troubleshooting, limits | Debugging, deployment issues |
90 
91## In This Reference
92- [configuration.md](./configuration.md) - Provider config, stack setup, Workers/bindings
93- [api.md](./api.md) - Resource types, Workers script, KV/D1/R2/queues/Pages
94- [patterns.md](./patterns.md) - Multi-env, secrets, CI/CD, stack management
95- [gotchas.md](./gotchas.md) - State issues, deployment failures, limits
96 
97## See Also
98- [terraform](../terraform/) - Alternative IaC for Cloudflare
99- [wrangler](../wrangler/) - CLI deployment alternative
100- [workers](../workers/) - Worker runtime documentation
101