From bd079529197833f07787f479847a06dfbcc6405f Mon Sep 17 00:00:00 2001 From: Oliver Barnwell Date: Fri, 3 Mar 2023 08:37:43 +0000 Subject: [PATCH] Add documentation for the `prefixStagePaths` parameter --- .../deployment_type/S3ObjectPrefixParameters.scala | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/magenta-lib/src/main/scala/magenta/deployment_type/S3ObjectPrefixParameters.scala b/magenta-lib/src/main/scala/magenta/deployment_type/S3ObjectPrefixParameters.scala index ea928a2d1..5468ae719 100644 --- a/magenta-lib/src/main/scala/magenta/deployment_type/S3ObjectPrefixParameters.scala +++ b/magenta-lib/src/main/scala/magenta/deployment_type/S3ObjectPrefixParameters.scala @@ -30,6 +30,15 @@ trait S3ObjectPrefixParameters { val prefixStagePaths: Param[Map[String, String]] = Param[Map[String, String]]( "prefixStagePaths", documentation = """ + |This option allows full control over the paths used for each stage, and will override all other prefix options. + | + |This is a useful escape hatch if you find yourself in a scenario where you are deploying to a single bucket and + |the upload path between stages cannot be repeated. + | + |**Note:** For the most part, you should not use this. + |If at all possible, prefer to use a single bucket per-stage. + | + |See our recommendation here: https://github.com/guardian/recommendations/blob/main/AWS.md?plain=1#L70 |```yaml |prefixStagePaths: | CODE: atoms-CODE