Skip to content

Commit 89f45d7

Browse files
docs(parameters): correct the documented default of recursive per provider (#8610)
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 <sulun6693485@163.com> Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
1 parent df93108 commit 89f45d7

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

‎docs/utilities/parameters.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,9 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen
296296
| Parameter | Default | Description |
297297
| ------------- | ------- | ---------------------------------------------------------------------------------------------- |
298298
| **decrypt** | `False` | Will automatically decrypt the parameter. |
299-
| **recursive** | `True` | For `get_multiple()` only, will fetch all parameter values recursively based on a path prefix. |
299+
| **recursive** | `False` | For `get_multiple()` only, will fetch all parameter values recursively based on a path prefix. |
300+
301+
The module-level `get_parameters()` function defaults `recursive` to `True`.
300302

301303
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.
302304

0 commit comments

Comments
 (0)