Skip to content

Commit f09a7e6

Browse files
committed
Documented Wrangler commands for listing, adding, removing, and updating R2 bucket custom domains
1 parent 13d7627 commit f09a7e6

File tree

1 file changed

+76
-6
lines changed

1 file changed

+76
-6
lines changed

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

Lines changed: 76 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -928,6 +928,74 @@ List R2 bucket in the current account.
928928
wrangler r2 bucket list
929929
```
930930

931+
### `domain add`
932+
933+
Connect a [custom domain](/r2/buckets/public-buckets/#custom-domains) to an R2 bucket.
934+
935+
```txt
936+
wrangler r2 bucket domain add <NAME> [OPTIONS]
937+
```
938+
939+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
940+
- The name of the R2 bucket to connect a custom domain to.
941+
- `--domain` <Type text="string" /> <MetaInfo text="required" />
942+
- The custom domain to connect to the R2 bucket.
943+
- `--zone-id` <Type text="string" /> <MetaInfo text="required" />
944+
- The [zone ID](/fundamentals/setup/find-account-and-zone-ids/) associated with the custom domain.
945+
- `--enabled` <Type text="boolean" /> <MetaInfo text="optional" />
946+
- Whether to enable public access at the custom domain (default is enabled).
947+
- `--min-tls` <Type text="'1.0'|'1.1'|'1.2'|'1.3'" /> <MetaInfo text="optional" />
948+
- Set the minimum TLS version for the custom domain (defaults to 1.0 if not set).
949+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
950+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
951+
952+
### `domain remove`
953+
954+
Remove a [custom domain](/r2/buckets/public-buckets/#custom-domains) from an R2 bucket.
955+
956+
```txt
957+
wrangler r2 bucket domain remove <NAME> [OPTIONS]
958+
```
959+
960+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
961+
- The name of the R2 bucket to remove the custom domain from.
962+
- `--domain` <Type text="string" /> <MetaInfo text="required" />
963+
- The custom domain to remove from the R2 bucket.
964+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
965+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
966+
967+
### `domain update`
968+
969+
Update settings for a [custom domain](/r2/buckets/public-buckets/#custom-domains) connected to an R2 bucket.
970+
971+
```txt
972+
wrangler r2 bucket domain update <NAME> [OPTIONS]
973+
```
974+
975+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
976+
- The name of the R2 bucket associated with the custom domain to update.
977+
- `--domain` <Type text="string" /> <MetaInfo text="required" />
978+
- The custom domain whose settings will be updated.
979+
- `--enabled` <Type text="boolean" /> <MetaInfo text="optional" />
980+
- Enable or disable public access at the custom domain.
981+
- `--min-tls` <Type text="'1.0'|'1.1'|'1.2'|'1.3'" /> <MetaInfo text="optional" />
982+
- Update the minimum TLS version for the custom domain.
983+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
984+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
985+
986+
### `domain list`
987+
988+
List [custom domains](/r2/buckets/public-buckets/#custom-domains) for an R2 bucket.
989+
990+
```txt
991+
wrangler r2 bucket domain list <NAME> [OPTIONS]
992+
```
993+
994+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
995+
- The name of the R2 bucket whose connected custom domains will be listed.
996+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
997+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
998+
931999
### `notification create`
9321000

9331001
Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket.
@@ -992,7 +1060,7 @@ wrangler r2 bucket sippy enable <NAME> [OPTIONS]
9921060
- `--r2-secret-access-key` <Type text="string" /> <MetaInfo text="required" />
9931061
- Your R2 Secret Access Key. Requires read and write access.
9941062
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
995-
- The jurisdiction where this R2 bucket is located, if a jurisdiction has been specified. Refer to [Jurisdictional Restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
1063+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
9961064
- **AWS S3 provider-specific options:**
9971065
- `--key-id` <Type text="string" /> <MetaInfo text="optional" />
9981066
- Your AWS Access Key ID. Requires [read and list access](/r2/data-migration/sippy/#amazon-s3).
@@ -1264,7 +1332,7 @@ wrangler workflows list
12641332
```
12651333

12661334
- `--page` <Type text="number" /> <MetaInfo text="optional" />
1267-
- Show a specific page from the listing. You can configure page size using "per-page".
1335+
- Show a specific page from the listing. You can configure page size using "per-page".
12681336
- `--per-page` <Type text="number" /> <MetaInfo text="optional" />
12691337
- Configure the maximum number of Workflows to show per page.
12701338

@@ -1300,6 +1368,7 @@ wrangler workflows instances describe <WORKFLOW_NAME> <ID> [OPTIONS]
13001368
# Passing `latest` instead of an explicit ID will describe the most recently queued instance
13011369
wrangler workflows instances describe my-workflow latest
13021370
```
1371+
13031372
```sh output
13041373
Workflow Name: my-workflow
13051374
Instance Id: 51c73fc8-7fd5-47d9-bd82-9e301506ee72
@@ -1368,6 +1437,7 @@ wrangler workflows describe <WORKFLOW_NAME> [OPTIONS]
13681437
### `trigger`
13691438

13701439
Trigger (create) a Workflow instance.
1440+
13711441
```sh
13721442
wrangler workflows describe <WORKFLOW_NAME> <PARAMS> [OPTIONS]
13731443
```
@@ -1377,10 +1447,10 @@ wrangler workflows describe <WORKFLOW_NAME> <PARAMS> [OPTIONS]
13771447
- `PARAMS` <Type text="string" /> <MetaInfo text="optional" />
13781448
- The parameters to pass to the Workflow as an event. Must be a JSON-encoded string.
13791449

1380-
```sh
1381-
# Pass optional params to the Workflow.
1382-
wrangler workflows instances trigger my-workflow '{"hello":"world"}'
1383-
```
1450+
```sh
1451+
# Pass optional params to the Workflow.
1452+
wrangler workflows instances trigger my-workflow '{"hello":"world"}'
1453+
```
13841454

13851455
### `delete`
13861456

0 commit comments

Comments
 (0)