Skip to content

docs(parameters): correct the documented default of recursive per provider #8610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SuellenQwQ wants to merge 1 commit into
base: develop
Choose a base branch
from
+3 −1
Open

docs(parameters): correct the documented default of recursive per provider #8610

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/utilities/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down