Skip to content

Commit c8e685e

Browse files
geekpeteDaveCTurner
authored andcommitted
Clarify S3 repository storage class parameter (#35400)
Today it is unclear that the `storage_class` parameter to an S3 repository only affects new objects and does not rewrite any existing objects. This commit clarifies this point.
1 parent 55ff96b commit c8e685e

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/plugins/repository-s3.asciidoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,12 @@ The following settings are supported:
208208

209209
`storage_class`::
210210

211-
Sets the S3 storage class type for the backup files. Values may be
212-
`standard`, `reduced_redundancy`, `standard_ia`. Defaults to `standard`.
211+
Sets the S3 storage class for objects stored in the snapshot repository.
212+
Values may be `standard`, `reduced_redundancy`, `standard_ia`.
213+
Defaults to `standard`. Changing this setting on an existing repository
214+
only affects the storage class for newly created objects, resulting in a
215+
mixed usage of storage classes. Additionally, S3 Lifecycle Policies can
216+
be used to manage the storage class of existing objects.
213217
Due to the extra complexity with the Glacier class lifecycle, it is not
214218
currently supported by the plugin. For more information about the
215219
different classes, see http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html[AWS Storage Classes Guide]

0 commit comments

Comments
 (0)