Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions src/content/docs/r2/examples/aws/aws-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,6 @@ import { Render } from "~/components";

With the [`aws`](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) CLI installed, you may run [`aws configure`](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config) to configure a new profile. You will be prompted with a series of questions for the new profile's details.

:::note[Compatibility]
Client versions `2.23.0` and `1.37.0` introduced a modification to the default checksum behavior from the client that is currently incompatible with R2 APIs.

To mitigate, users can use `2.22.35` or `1.36.40`, or alternatively, add the CRC32 checksum flag to the cli command:

```sh
aws s3api put-object --bucket sdk-example --key sdk.png --body file/path --checksum-algorithm CRC32
```

:::

```shell
aws configure
```
Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/r2/examples/aws/aws-sdk-go.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ import { Render } from "~/components";

This example uses version 2 of the [aws-sdk-go](https://github.com/aws/aws-sdk-go-v2) package. You must pass in the R2 configuration credentials when instantiating your `S3` service client:

:::note[Compatibility]
Client version `1.73.0` introduced a modification to the default checksum behavior from the client that is currently incompatible with R2 APIs.

To mitigate, users can use `1.72.3` or add the following to their config:

```go
config.WithRequestChecksumCalculation(0)
config.WithResponseChecksumValidation(0)
```

:::

```go
package main

Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/r2/examples/aws/aws-sdk-java.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ import { Render } from "~/components";

This example uses version 2 of the [aws-sdk-java](https://github.com/aws/aws-sdk-java-v2/#using-the-sdk) package. You must pass in the R2 configuration credentials when instantiating your `S3` service client:

:::note[Compatibility]
Client version `2.30.0` introduced a modification to the default checksum behavior from the client that is currently incompatible with R2 APIs.

To mitigate, users can use `2.29.52` or add the following to their S3Config:

```java
this.requestChecksumCalculation = "when_required",
this.responseChecksumValidation = "when_required"
```

:::

```java
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/r2/examples/aws/aws-sdk-js-v3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,6 @@ JavaScript or TypeScript users may continue to use the [`@aws-sdk/client-s3`](ht
Currently, you cannot use AWS S3-compatible API while developing locally via `wrangler dev`.
:::

:::note[Compatibility]
Client version `3.729.0` introduced a modification to the default checksum behavior from the client that is currently incompatible with R2 APIs.

To mitigate, users can use `3.726.1` or add the following to their S3Client config:

```ts
requestChecksumCalculation: "WHEN_REQUIRED",
responseChecksumValidation: "WHEN_REQUIRED",
```

:::

```ts
import {
S3Client,
Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/r2/examples/aws/aws-sdk-net.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,6 @@ This example uses version 3 of the [aws-sdk-net](https://www.nuget.org/packages/

In this example, you will pass credentials explicitly to the `IAmazonS3` initialization. If you wish, use a shared AWS credentials file or the SDK store in-line with other AWS SDKs. Refer to [Configure AWS credentials](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/net-dg-config-creds.html) for more details.

:::note[Compatibility]
Client version `3.7.963.0` introduced a modification to the default checksum behavior from the client that is currently incompatible with R2 APIs.

To mitigate, users can use `3.7.962.0` or add the following to their AmazonS3Config:

```csharp
RequestChecksumCalculation = "WHEN_REQUIRED",
ResponseChecksumValidation = "WHEN_REQUIRED"
```

:::

```csharp
private static IAmazonS3 s3Client;

Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/r2/examples/aws/aws-sdk-php.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,6 @@ import { Render } from "~/components";

This example uses version 3 of the [aws-sdk-php](https://packagist.org/packages/aws/aws-sdk-php) package. You must pass in the R2 configuration credentials when instantiating your `S3` service client:

:::note[Compatibility]
Client version `3.337.0` introduced a modification to the default checksum behavior from the client that is currently incompatible with R2 APIs.

To mitigate, users can use `3.336.15` or add the following to their $options:

```php
'request_checksum_calculation' => 'when_required',
'response_checksum_validation' => 'when_required'
```

:::

```php
<?php
require 'vendor/aws/aws-autoloader.php';
Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/r2/examples/aws/aws-sdk-ruby.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ import { Render } from "~/components";

Many Ruby projects also store these credentials in environment variables instead.

:::note[Compatibility]
Client version `1.178.0` introduced a modification to the default checksum behavior from the client that is currently incompatible with R2 APIs.

To mitigate, users can use `1.177.0` or add the following to their s3 client instantiation:

```ruby
request_checksum_calculation: "when_required",
response_checksum_validation: "when_required"
```

:::

Add the following dependency to your `Gemfile`:

```ruby
Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/r2/examples/aws/aws-sdk-rust.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ import { Render } from "~/components";

This example uses the [aws-sdk-s3](https://crates.io/crates/aws-sdk-s3) crate from the [AWS SDK for Rust](https://github.com/awslabs/aws-sdk-rust). You must pass in the R2 configuration credentials when instantiating your `S3` client:

:::note[Compatibility]
Client versions may introduce modifications to the default checksum behavior that could be incompatible with R2 APIs.

If you encounter checksum-related errors, add the following to your config:

```rust
.request_checksum_calculation(RequestChecksumCalculation::WhenRequired)
.response_checksum_validation(ResponseChecksumValidation::WhenRequired)
```

:::

## Basic Usage

```rust
Expand Down
12 changes: 0 additions & 12 deletions src/content/docs/r2/examples/aws/boto3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ import { Render } from "~/components";

You must configure [`boto3`](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) to use a preconstructed `endpoint_url` value. This can be done through any `boto3` usage that accepts connection arguments; for example:

:::note[Compatibility]
Client version `1.36.0` introduced a modification to the default checksum behavior from the client that is currently incompatible with R2 APIs.

To mitigate, users can use `1.35.99` or add the following to their s3 resource config:

```python
request_checksum_calculation = 'WHEN_REQUIRED',
response_checksum_validation = 'WHEN_REQUIRED'
```

:::

```python
import boto3

Expand Down
3 changes: 3 additions & 0 deletions src/content/release-notes/r2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ productLink: "/r2/"
productArea: Developer platform
productAreaLink: /workers/platform/changelog/platform/
entries:
- publish_date: "2025-07-03"
description: |-
- The CRC64NVME Checksum algorithm is now supported for both Single- and Multipart objects. This also brings support for the `FULL_OBJECT` Checksum Type on Multipart Uploads.
- publish_date: "2024-12-03"
description: |-
- [Server-side Encryption with Customer-Provided Keys](/r2/examples/ssec/) is now available to all users via the Workers and S3-compatible APIs.
Expand Down