Skip to content

Commit 0ca5b07

Browse files
jonesphillipjonesphillip
committed
Document wrangler r2 lock command (list, add, remove, set)
1 parent ef31bf7 commit 0ca5b07

File tree

1 file changed

+130
-13
lines changed
  • src/content/partials/workers/wrangler-commands

1 file changed

+130
-13
lines changed

‎src/content/partials/workers/wrangler-commands/r2.mdx‎

Lines changed: 130 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,11 @@ wrangler r2 bucket cors list <NAME> [OPTIONS]
107107
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
108108
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
109109

110-
<AnchorHeading title="`dev-url enable`" slug="r2-bucket-dev-url-enable" depth={3} />
110+
<AnchorHeading
111+
title="`dev-url enable`"
112+
slug="r2-bucket-dev-url-enable"
113+
depth={3}
114+
/>
111115

112116
Enable public access via the [r2.dev URL](/r2/buckets/public-buckets/#enable-managed-public-access) for an R2 bucket.
113117

@@ -122,7 +126,11 @@ wrangler r2 bucket dev-url enable <NAME> [OPTIONS]
122126
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
123127
- Skip confirmation when enabling public access via r2.dev URL.
124128

125-
<AnchorHeading title="`dev-url disable`" slug="r2-bucket-dev-url-disable" depth={3} />
129+
<AnchorHeading
130+
title="`dev-url disable`"
131+
slug="r2-bucket-dev-url-disable"
132+
depth={3}
133+
/>
126134

127135
Disable public access via the [r2.dev URL](/r2/buckets/public-buckets/#enable-managed-public-access) for an R2 bucket.
128136

@@ -171,7 +179,11 @@ wrangler r2 bucket domain add <NAME> [OPTIONS]
171179
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
172180
- Skip confirmation when adding the custom domain.
173181

174-
<AnchorHeading title="`domain remove`" slug="r2-bucket-domain-remove" depth={3} />
182+
<AnchorHeading
183+
title="`domain remove`"
184+
slug="r2-bucket-domain-remove"
185+
depth={3}
186+
/>
175187

176188
Remove a [custom domain](/r2/buckets/public-buckets/#custom-domains) from an R2 bucket.
177189

@@ -188,7 +200,11 @@ wrangler r2 bucket domain remove <NAME> [OPTIONS]
188200
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
189201
- Skip confirmation when removing the custom domain.
190202

191-
<AnchorHeading title="`domain update`" slug="r2-bucket-domain-update" depth={3} />
203+
<AnchorHeading
204+
title="`domain update`"
205+
slug="r2-bucket-domain-update"
206+
depth={3}
207+
/>
192208

193209
Update settings for a [custom domain](/r2/buckets/public-buckets/#custom-domains) connected to an R2 bucket.
194210

@@ -233,7 +249,11 @@ wrangler r2 bucket domain list <NAME> [OPTIONS]
233249
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
234250
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
235251

236-
<AnchorHeading title="`lifecycle add`" slug="r2-bucket-lifecycle-add" depth={3} />
252+
<AnchorHeading
253+
title="`lifecycle add`"
254+
slug="r2-bucket-lifecycle-add"
255+
depth={3}
256+
/>
237257

238258
Add an [object lifecycle](/r2/buckets/object-lifecycles/) rule to an R2 bucket.
239259

@@ -262,7 +282,11 @@ wrangler r2 bucket lifecycle add <NAME> [OPTIONS]
262282
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
263283
- Skip confirmation when adding the lifecycle rule.
264284

265-
<AnchorHeading title="`lifecycle remove`" slug="r2-bucket-lifecycle-remove" depth={3} />
285+
<AnchorHeading
286+
title="`lifecycle remove`"
287+
slug="r2-bucket-lifecycle-remove"
288+
depth={3}
289+
/>
266290

267291
Remove an [object lifecycle](/r2/buckets/object-lifecycles/) rule from an R2 bucket.
268292

@@ -277,7 +301,11 @@ wrangler r2 bucket lifecycle remove <NAME> [OPTIONS]
277301
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
278302
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
279303

280-
<AnchorHeading title="`lifecycle list`" slug="r2-bucket-lifecycle-list" depth={3} />
304+
<AnchorHeading
305+
title="`lifecycle list`"
306+
slug="r2-bucket-lifecycle-list"
307+
depth={3}
308+
/>
281309

282310
List [object lifecycle](/r2/buckets/object-lifecycles/) rules for an R2 bucket.
283311

@@ -290,7 +318,11 @@ wrangler r2 bucket lifecycle list <NAME> [OPTIONS]
290318
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
291319
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
292320

293-
<AnchorHeading title="`lifecycle set`" slug="r2-bucket-lifecycle-set" depth={3} />
321+
<AnchorHeading
322+
title="`lifecycle set`"
323+
slug="r2-bucket-lifecycle-set"
324+
depth={3}
325+
/>
294326

295327
Set the [object lifecycle](/r2/buckets/object-lifecycles/) configuration for an R2 bucket from a JSON file.
296328

@@ -307,7 +339,79 @@ wrangler r2 bucket lifecycle set <NAME> [OPTIONS]
307339
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
308340
- Skip confirmation when setting object lifecycle configuration.
309341

310-
<AnchorHeading title="`notification create`" slug="r2-bucket-notification-create" depth={3} />
342+
<AnchorHeading title="`lock add`" slug="r2-bucket-lock-add" depth={3} />
343+
344+
Add a [bucket lock](/r2/buckets/bucket-locks/) rule to an R2 bucket.
345+
346+
```txt
347+
wrangler r2 bucket lock add <NAME> [OPTIONS]
348+
```
349+
350+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
351+
- The name of the R2 bucket to add a bucket lock rule to.
352+
- `--id` <Type text="string" /> <MetaInfo text="optional" />
353+
- A unique identifier for the bucket lock rule.
354+
- `--prefix` <Type text="string" /> <MetaInfo text="optional" />
355+
- Prefix condition for the bucket lock rule (leave empty for all prefixes).
356+
- `--lock-days` <Type text="number" /> <MetaInfo text="optional" />
357+
- Sets the number of days to lock objects for. Note you can provide only one of `--lock-days` or `--lock-date`.
358+
- `--lock-date` <Type text="string" /> <MetaInfo text="optional" />
359+
- Sets the date (YYYY-MM-DD) until which objects will be locked for. Note you can provide only one of `--lock-days` or `--lock-date`.
360+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
361+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
362+
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
363+
- Skip confirmation when adding the bucket lock rule.
364+
365+
<AnchorHeading title="`lock remove`" slug="r2-bucket-lock-remove" depth={3} />
366+
367+
Remove a [bucket lock](/r2/buckets/bucket-locks/) rule from an R2 bucket.
368+
369+
```txt
370+
wrangler r2 bucket lock remove <NAME> [OPTIONS]
371+
```
372+
373+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
374+
- The name of the R2 bucket to remove a bucket lock rule from.
375+
- `--id` <Type text="string" /> <MetaInfo text="required" />
376+
- The unique identifier of the bucket lock rule to remove.
377+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
378+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
379+
380+
<AnchorHeading title="`lock list`" slug="r2-bucket-lock-list" depth={3} />
381+
382+
List [bucket lock](/r2/buckets/bucket-locks/) rules for an R2 bucket.
383+
384+
```txt
385+
wrangler r2 bucket lock list <NAME> [OPTIONS]
386+
```
387+
388+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
389+
- The name of the R2 bucket to list bucket locks rules for.
390+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
391+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
392+
393+
<AnchorHeading title="`lock set`" slug="r2-bucket-lock-set" depth={3} />
394+
395+
Set the [bucket lock](/r2/buckets/bucket-locks/) configuration for an R2 bucket from a JSON file.
396+
397+
```txt
398+
wrangler r2 bucket lock set <NAME> [OPTIONS]
399+
```
400+
401+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
402+
- The name of the R2 bucket to set bucket lock configuration for.
403+
- `--file` <Type text="string" /> <MetaInfo text="required" />
404+
- Path to the JSON file containing bucket lock configuration (file must be in format of request body of [put bucket lock configuration API](/api/resources/r2/subresources/buckets/subresources/locks/methods/update/)).
405+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
406+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
407+
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
408+
- Skip confirmation when setting bucket lock configuration.
409+
410+
<AnchorHeading
411+
title="`notification create`"
412+
slug="r2-bucket-notification-create"
413+
depth={3}
414+
/>
311415

312416
Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket.
313417

@@ -328,7 +432,11 @@ wrangler r2 bucket notification create <NAME> [OPTIONS]
328432
- `--description` <Type text="string" /> <MetaInfo text="optional" />
329433
- A description that can be used to identify the event notification rule after creation.
330434

331-
<AnchorHeading title="`notification delete`" slug="r2-bucket-notification-delete" depth={3} />
435+
<AnchorHeading
436+
title="`notification delete`"
437+
slug="r2-bucket-notification-delete"
438+
depth={3}
439+
/>
332440

333441
Remove an event notification rule from a bucket's [event notification](/r2/buckets/event-notifications/) configuration.
334442

@@ -343,7 +451,11 @@ wrangler r2 bucket notification delete <NAME> [OPTIONS]
343451
- `--rule` <Type text="string" /> <MetaInfo text="optional" />
344452
- The ID of the event notification rule to delete.
345453

346-
<AnchorHeading title="`notification list`" slug="r2-bucket-notification-list" depth={3} />
454+
<AnchorHeading
455+
title="`notification list`"
456+
slug="r2-bucket-notification-list"
457+
depth={3}
458+
/>
347459

348460
List the [event notification](/r2/buckets/event-notifications/) rules for a bucket.
349461

@@ -390,7 +502,11 @@ wrangler r2 bucket sippy enable <NAME> [OPTIONS]
390502
- The private key for your Google Cloud service account key. Requires [read and list access](/r2/data-migration/sippy/#google-cloud-storage).
391503
- Note that you must provide either `service-account-key-file` or `client_email` and `private_key` for this command to run successfully.
392504

393-
<AnchorHeading title="`sippy disable`" slug="r2-bucket-sippy-disable" depth={3} />
505+
<AnchorHeading
506+
title="`sippy disable`"
507+
slug="r2-bucket-sippy-disable"
508+
depth={3}
509+
/>
394510

395511
Disable [Sippy](/r2/data-migration/sippy/) incremental migration for a bucket.
396512

@@ -483,5 +599,6 @@ wrangler r2 object delete <OBJECT_PATH> [OPTIONS]
483599
- Specify directory for locally persisted data.
484600

485601
:::note
602+
486603
<Render file="wrangler-commands/global-flags" product="workers" />
487-
:::
604+
:::

0 commit comments

Comments
 (0)