Skip to content

Commit f1738ea

Browse files
jonesphillipharshil1712
authored andcommitted
Docs for wrangler commands for listing, adding, removing, and updating R2 bucket custom domains (#17802)
* Documented Wrangler commands for listing, adding, removing, and updating R2 bucket custom domains * Added documentation for force option in R2 bucket domain remove command * Remove documentation for enabled option in R2 bucket domain commands
1 parent 0609f5e commit f1738ea

File tree

1 file changed

+70
-2
lines changed

1 file changed

+70
-2
lines changed

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

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -932,6 +932,74 @@ List R2 bucket in the current account.
932932
wrangler r2 bucket list
933933
```
934934

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

9371005
Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket.
@@ -998,7 +1066,7 @@ wrangler r2 bucket sippy enable <NAME> [OPTIONS]
9981066
- `--r2-secret-access-key` <Type text="string" /> <MetaInfo text="required" />
9991067
- Your R2 Secret Access Key. Requires read and write access.
10001068
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
1001-
- The jurisdiction where this R2 bucket is located, if a jurisdiction has been specified. Refer to [Jurisdictional Restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
1069+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
10021070
- **AWS S3 provider-specific options:**
10031071
- `--key-id` <Type text="string" /> <MetaInfo text="optional" />
10041072
- Your AWS Access Key ID. Requires [read and list access](/r2/data-migration/sippy/#amazon-s3).
@@ -1270,7 +1338,7 @@ wrangler workflows list
12701338
```
12711339

12721340
- `--page` <Type text="number" /> <MetaInfo text="optional" />
1273-
- Show a specific page from the listing. You can configure page size using "per-page".
1341+
- Show a specific page from the listing. You can configure page size using "per-page".
12741342
- `--per-page` <Type text="number" /> <MetaInfo text="optional" />
12751343
- Configure the maximum number of Workflows to show per page.
12761344

0 commit comments

Comments
 (0)