diff --git a/src/content/docs/workers/wrangler/commands.mdx b/src/content/docs/workers/wrangler/commands.mdx index 5c83a133acd38e..330359590e3741 100644 --- a/src/content/docs/workers/wrangler/commands.mdx +++ b/src/content/docs/workers/wrangler/commands.mdx @@ -932,6 +932,74 @@ List R2 bucket in the current account. wrangler r2 bucket list ``` +### `domain add` + +Connect a [custom domain](/r2/buckets/public-buckets/#custom-domains) to an R2 bucket. + +```txt +wrangler r2 bucket domain add [OPTIONS] +``` + +- `NAME` + - The name of the R2 bucket to connect a custom domain to. +- `--domain` + - The custom domain to connect to the R2 bucket. +- `--zone-id` + - The [zone ID](/fundamentals/setup/find-account-and-zone-ids/) associated with the custom domain. +- `--min-tls` + - Set the minimum TLS version for the custom domain (defaults to 1.0 if not set). +- `--jurisdiction` + - The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions). +- `--force` + - Skip confirmation when adding the custom domain. + +### `domain remove` + +Remove a [custom domain](/r2/buckets/public-buckets/#custom-domains) from an R2 bucket. + +```txt +wrangler r2 bucket domain remove [OPTIONS] +``` + +- `NAME` + - The name of the R2 bucket to remove the custom domain from. +- `--domain` + - The custom domain to remove from the R2 bucket. +- `--jurisdiction` + - The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions). +- `--force` + - Skip confirmation when removing the custom domain. + +### `domain update` + +Update settings for a [custom domain](/r2/buckets/public-buckets/#custom-domains) connected to an R2 bucket. + +```txt +wrangler r2 bucket domain update [OPTIONS] +``` + +- `NAME` + - The name of the R2 bucket associated with the custom domain to update. +- `--domain` + - The custom domain whose settings will be updated. +- `--min-tls` + - Update the minimum TLS version for the custom domain. +- `--jurisdiction` + - The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions). + +### `domain list` + +List [custom domains](/r2/buckets/public-buckets/#custom-domains) for an R2 bucket. + +```txt +wrangler r2 bucket domain list [OPTIONS] +``` + +- `NAME` + - The name of the R2 bucket whose connected custom domains will be listed. +- `--jurisdiction` + - The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions). + ### `notification create` Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket. @@ -998,7 +1066,7 @@ wrangler r2 bucket sippy enable [OPTIONS] - `--r2-secret-access-key` - Your R2 Secret Access Key. Requires read and write access. - `--jurisdiction` - - The jurisdiction where this R2 bucket is located, if a jurisdiction has been specified. Refer to [Jurisdictional Restrictions](/r2/reference/data-location/#jurisdictional-restrictions). + - The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions). - **AWS S3 provider-specific options:** - `--key-id` - Your AWS Access Key ID. Requires [read and list access](/r2/data-migration/sippy/#amazon-s3). @@ -1270,7 +1338,7 @@ wrangler workflows list ``` - `--page` - - Show a specific page from the listing. You can configure page size using "per-page". + - Show a specific page from the listing. You can configure page size using "per-page". - `--per-page` - Configure the maximum number of Workflows to show per page.