Skip to content

Commit d267ac9

Browse files
jonesphillipmaheshwarip
authored andcommitted
Update R2 event notifications Wrangler command docs (#16873)
1 parent 26ede5e commit d267ac9

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
@@ -986,7 +986,7 @@ wrangler delete [<SCRIPT>] [OPTIONS]
986986
- `--dry-run` boolean (default: false) optional
987987
- Do not actually delete the Worker. This is useful for testing the output of `wrangler delete`.
988988

989-
<Render file="wrangler-commands/kv" product="workers"/>
989+
<Render file="wrangler-commands/kv" product="workers" />
990990

991991
---
992992

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

10451045
```txt
1046-
wrangler r2 bucket notification create <NAME> --event-type <EVENT_TYPE> --queue <QUEUE_NAME> [OPTIONS]]
1046+
wrangler r2 bucket notification create <NAME> [OPTIONS]
10471047
```
10481048

10491049
- `NAME` string required
10501050
- The name of the R2 bucket to create an event notification rule for.
1051-
- `EVENT_TYPE` "object-create"|"object-delete" required
1052-
- The [type of event](/r2/buckets/event-notifications/#event-types) that will trigger event notifications.
1053-
- `QUEUE_NAME` string required
1051+
- `--event-type` "object-create"|"object-delete"[] required
1052+
- The [type of event(s)](/r2/buckets/event-notifications/#event-types) that will trigger event notifications.
1053+
- `--queue` string required
10541054
- The name of the queue that will receive event notification messages.
10551055
- `--prefix` string optional
1056-
- 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.
1056+
- The prefix that an object must match to emit event notifications (note: regular expressions are not supported).
10571057
- `--suffix` string optional
1058-
- 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.
1058+
- The suffix that an object must match to emit event notifications (note: regular expressions are not supported).
10591059

10601060
### `notification delete`
10611061

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

10641064
```txt
1065-
wrangler r2 bucket notification delete <NAME> --queue <QUEUE_NAME>
1065+
wrangler r2 bucket notification delete <NAME> [OPTIONS]
10661066
```
10671067

10681068
- `NAME` string required
10691069
- The name of the R2 bucket to delete an event notification rule for.
1070-
- `QUEUE_NAME` string required
1071-
- The name of the queue that corresponds to the event notification rule.
1070+
- `--queue` string required
1071+
- 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.
1072+
- `--rule` string optional
1073+
- The ID of the event notification rule to delete.
10721074

10731075
### `notification get`
10741076

@@ -1864,7 +1866,6 @@ wrangler whoami
18641866

18651867
## `versions`
18661868

1867-
18681869
:::note
18691870
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.
18701871
:::
@@ -1965,7 +1966,6 @@ wrangler versions secret bulk <FILENAME> [OPTIONS]
19651966

19661967
## `triggers`
19671968

1968-
19691969
:::note
19701970
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.
19711971
:::

0 commit comments

Comments
 (0)