From 7a8207b3078f6689c609fb701b79783bbe6953b9 Mon Sep 17 00:00:00 2001 From: SuellenQAQ Date: Sun, 18 Oct 2026 21:16:30 +0800 Subject: [PATCH] docs(parameters): correct the documented default of recursive per provider docs/utilities/parameters.md documented `recursive` as defaulting to `True` for `get_multiple()`, but that only holds for the module-level `get_parameters()`; `SSMProvider.get_multiple()` defaults to `False`. Aligns the SSM options table with the code. No behaviour change - the provider default is intentionally left as-is to avoid a breaking change. Signed-off-by: SuellenQAQ --- docs/utilities/parameters.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index 96c94e40055..38f4684a138 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -296,7 +296,9 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen | Parameter | Default | Description | | ------------- | ------- | ---------------------------------------------------------------------------------------------- | | **decrypt** | `False` | Will automatically decrypt the parameter. | -| **recursive** | `True` | For `get_multiple()` only, will fetch all parameter values recursively based on a path prefix. | +| **recursive** | `False` | For `get_multiple()` only, will fetch all parameter values recursively based on a path prefix. | + +The module-level `get_parameters()` function defaults `recursive` to `True`. You can create `SecureString` parameters, which are parameters that have a plaintext parameter name and an encrypted parameter value. If you don't use the `decrypt` argument, you will get an encrypted value. Read [here](https://docs.aws.amazon.com/kms/latest/developerguide/services-parameter-store.html) about best practices using KMS to secure your parameters.