Skip to content

RavenDB-23846 - Document S3 storage class option for Amazon S3 backups #2338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ppekrol wants to merge 2 commits into
base: main
Choose a base branch
from
Open

RavenDB-23846 - Document S3 storage class option for Amazon S3 backups #2338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ca0ef6
RavenDB-23846 - Document S3 storage class option for Amazon S3 backups
ppekrol Mar 15, 2026
e119497
RavenDB-23846 - Fix broken link path in backup-task.mdx
ppekrol Mar 15, 2026
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
38 changes: 36 additions & 2 deletions docs/client-api/operations/maintenance/backup/backup-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,10 @@ IncrementalBackupFrequency = "*/20 * * * *",
AwsAccessKey = "your access key here",
AwsSecretKey = "your secret key here",
AwsRegionName = "OPTIONAL",
BucketName = "john-bucket"
BucketName = "john-bucket",

// Optional: set the S3 storage class (default is Standard)
StorageClass = S3StorageClass.Standard
\},

// Amazon Glacier settings.
Expand Down Expand Up @@ -308,6 +311,34 @@ var result = await docStore.Maintenance.SendAsync(operation);
</TabItem>
</Admonition>

### S3 Storage Class

When backing up to Amazon S3, you can specify the **storage class** to use for the uploaded backup files
by setting the `StorageClass` property on `S3Settings`.
If not set, S3 uses the `Standard` storage class by default.

Choosing a different storage class allows you to optimize backup storage costs based on your access patterns and retention needs.

| Storage Class | Enum Value | Description |
| - | - | - |
| **Standard** | `S3StorageClass.Standard` | Default. High durability, availability, and performance for frequently accessed data. |
| **Intelligent Tiering** | `S3StorageClass.IntelligentTiering` | Automatically moves data between access tiers based on changing access patterns. |
| **Standard-IA** | `S3StorageClass.StandardInfrequentAccess` | For long-lived, infrequently accessed data. Lower storage cost, retrieval fee applies. |
| **One Zone-IA** | `S3StorageClass.OneZoneInfrequentAccess` | Similar to Standard-IA but stored in a single Availability Zone. Lower cost, less resilience. |
| **Glacier Instant Retrieval** | `S3StorageClass.GlacierInstantRetrieval` | Archive storage with millisecond retrieval. For data accessed once per quarter. |
| **Glacier Flexible Retrieval** | `S3StorageClass.Glacier` | Low-cost archive storage. Retrieval times range from minutes to hours. |
| **Deep Archive** | `S3StorageClass.DeepArchive` | Lowest-cost storage for long-term archival. Retrieval time is 12–48 hours. |
| **Reduced Redundancy** | `S3StorageClass.ReducedRedundancy` | Lower durability than Standard. For non-critical, reproducible data. |
| **Express One Zone** | `S3StorageClass.ExpressOneZone` | Single-zone storage optimized for low-latency access. |

<Admonition type="warning" title="Glacier and Deep Archive">

When using Glacier-tier storage classes (`Glacier`, `DeepArchive`), backup files are not immediately available
for restore. You must first initiate an archive retrieval (thaw) through the AWS console or API before
RavenDB can restore from these backups.

</Admonition>


## Backup Retention Policy

Expand Down Expand Up @@ -401,7 +432,10 @@ A server-wide backup configuration that sets multiple destinations:
AwsSecretKey = "Amazon S3 Secret Key",
AwsRegionName = "Amazon S3 Region Name",
BucketName = "john-bucket",
RemoteFolderName = "john/backups"
RemoteFolderName = "john/backups",

// Optional: set the S3 storage class (default is Standard)
StorageClass = S3StorageClass.StandardInfrequentAccess
\},

//Amazon Glacier settings.
Expand Down
12 changes: 8 additions & 4 deletions docs/studio/database/tasks/backup-task.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,14 @@ Make sure to save the destinations and credentials information so that your team
2. Cloud storage options
* [Amazon S3](https://aws.amazon.com/s3/)
![ForcePathStyle](./assets/studio-force-path-style.png)
* a- **Use a custom S3 host**
Toggle to provide a custom server URL.
* b- **Force path style**
Toggle to change the default S3 bucket [path convention](https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/) on your custom Amazon S3 host.
* a- **Use a custom S3 host**
Toggle to provide a custom server URL.
* b- **Force path style**
Toggle to change the default S3 bucket [path convention](https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/) on your custom Amazon S3 host.
* c- **Storage class**
Select the [S3 storage class](../../../client-api/operations/maintenance/backup/backup-overview.mdx#s3-storage-class)
for backup files (e.g., Standard, Standard-IA, Intelligent Tiering, Glacier).
Default: `Standard`.
* [Microsoft Azure](https://azure.microsoft.com/en-us/services/storage/)
* [Google Cloud](https://cloud.google.com/)
* [Amazon Glacier](https://aws.amazon.com/glacier/)
Expand Down
Loading