Skip to content

Commit e43d6ae

Browse files
authored
Update R2 event notifications Wrangler command docs (#16873)
1 parent 2a12ffa commit e43d6ae

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/content/docs/workers/wrangler/commands.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -985,7 +985,7 @@ wrangler delete [<SCRIPT>] [OPTIONS]
985985
- `--dry-run` boolean (default: false) optional
986986
- Do not actually delete the Worker. This is useful for testing the output of `wrangler delete`.
987987

988-
<Render file="wrangler-commands/kv" product="workers"/>
988+
<Render file="wrangler-commands/kv" product="workers" />
989989

990990
---
991991

@@ -1042,32 +1042,34 @@ Event notifications is currently in beta. To report bugs or request features, fi
10421042
Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket.
10431043

10441044
```txt
1045-
wrangler r2 bucket notification create <NAME> --event-type <EVENT_TYPE> --queue <QUEUE_NAME> [OPTIONS]]
1045+
wrangler r2 bucket notification create <NAME> [OPTIONS]
10461046
```
10471047

10481048
- `NAME` string required
10491049
- The name of the R2 bucket to create an event notification rule for.
1050-
- `EVENT_TYPE` "object-create"|"object-delete" required
1051-
- The [type of event](/r2/buckets/event-notifications/#event-types) that will trigger event notifications.
1052-
- `QUEUE_NAME` string required
1050+
- `--event-type` "object-create"|"object-delete"[] required
1051+
- The [type of event(s)](/r2/buckets/event-notifications/#event-types) that will trigger event notifications.
1052+
- `--queue` string required
10531053
- The name of the queue that will receive event notification messages.
10541054
- `--prefix` string optional
1055-
- Specifies the key name prefix that an object must match to trigger event notifications. The value must be a string. Regular expressions are not supported.
1055+
- The prefix that an object must match to emit event notifications (note: regular expressions are not supported).
10561056
- `--suffix` string optional
1057-
- Specifies the key name suffix that an object must match to trigger event notifications. The value must be a string. Regular expressions are not supported.
1057+
- The suffix that an object must match to emit event notifications (note: regular expressions are not supported).
10581058

10591059
### `notification delete`
10601060

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

10631063
```txt
1064-
wrangler r2 bucket notification delete <NAME> --queue <QUEUE_NAME>
1064+
wrangler r2 bucket notification delete <NAME> [OPTIONS]
10651065
```
10661066

10671067
- `NAME` string required
10681068
- The name of the R2 bucket to delete an event notification rule for.
1069-
- `QUEUE_NAME` string required
1070-
- The name of the queue that corresponds to the event notification rule.
1069+
- `--queue` string required
1070+
- The name of the queue that corresponds to the event notification rule. If no `rule` is provided, all event notification rules associated with the queue will be deleted.
1071+
- `--rule` string optional
1072+
- The ID of the event notification rule to delete.
10711073

10721074
### `notification get`
10731075

@@ -1787,7 +1789,6 @@ wrangler whoami
17871789

17881790
## `versions`
17891791

1790-
17911792
:::note
17921793
The minimum required wrangler version to use these commands is 3.40.0. For versions before 3.73.0, you will need to add the `--x-versions` flag.
17931794
:::
@@ -1888,7 +1889,6 @@ wrangler versions secret bulk <FILENAME> [OPTIONS]
18881889

18891890
## `triggers`
18901891

1891-
18921892
:::note
18931893
The minimum required wrangler version to use these commands is 3.40.0. For versions before 3.73.0, you will need to add the `--x-versions` flag.
18941894
:::

0 commit comments

Comments
 (0)