From 0ca0ef63e04f55bae1fb9e8a8a64b5808b453e47 Mon Sep 17 00:00:00 2001 From: Pawel Pekrol Date: Sun, 15 Mar 2026 21:53:37 +0100 Subject: [PATCH 1/2] RavenDB-23846 - Document S3 storage class option for Amazon S3 backups --- .../maintenance/backup/backup-overview.mdx | 38 ++++++++++++++++++- docs/studio/database/tasks/backup-task.mdx | 12 ++++-- 2 files changed, 44 insertions(+), 6 deletions(-) diff --git a/docs/client-api/operations/maintenance/backup/backup-overview.mdx b/docs/client-api/operations/maintenance/backup/backup-overview.mdx index 83050a936e..e603db2961 100644 --- a/docs/client-api/operations/maintenance/backup/backup-overview.mdx +++ b/docs/client-api/operations/maintenance/backup/backup-overview.mdx @@ -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. @@ -308,6 +311,34 @@ var result = await docStore.Maintenance.SendAsync(operation); +### 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. | + + + +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. + + + ## Backup Retention Policy @@ -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. diff --git a/docs/studio/database/tasks/backup-task.mdx b/docs/studio/database/tasks/backup-task.mdx index 97561c7b80..9caa223447 100644 --- a/docs/studio/database/tasks/backup-task.mdx +++ b/docs/studio/database/tasks/backup-task.mdx @@ -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/) From e1194977abf2a5c5f51912f5a2a09801d2c25049 Mon Sep 17 00:00:00 2001 From: Pawel Pekrol Date: Sun, 15 Mar 2026 22:04:37 +0100 Subject: [PATCH 2/2] RavenDB-23846 - Fix broken link path in backup-task.mdx --- docs/studio/database/tasks/backup-task.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/studio/database/tasks/backup-task.mdx b/docs/studio/database/tasks/backup-task.mdx index 9caa223447..cbf82025df 100644 --- a/docs/studio/database/tasks/backup-task.mdx +++ b/docs/studio/database/tasks/backup-task.mdx @@ -189,7 +189,7 @@ Make sure to save the destinations and credentials information so that your team * 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) + 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/)