Reference
AWS SSM Parameter Store
Move parameters to and from an SSM path.
Move parameters to and from an SSM path.
A newer connection reaches the same service: AWS SSM Parameter Store (IAM role).
The connection
| What | This provider |
|---|---|
| Vendor | Amazon Web Services |
| Key | aws-ssm |
| Availability | available. You can connect it today. |
| Credential penv holds | aws-iam |
| Values read back | yes |
| Activation | immediate |
What it moves
| Direction | What it does |
|---|---|
import | Reads names and values out of the store into penv. |
export | Writes names and values from penv into the store. |
When a written value goes live
immediate. The running app sees a new value at once.
What happens to a name that exists
| Direction | Policies you can pick |
|---|---|
import | skip_existing, new_version, fail |
export | create_only, overwrite, overwrite_and_prune |
How syncs work says what each one does.
How you connect
You paste a credential you already hold. penv seals it and never shows it again.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
accessKeyId | Access key ID | text | yes | |
secretAccessKey | Secret access key | secret, masked here and sealed | yes |
What the connection asks for
Fixed when you connect, and shared by every mapping on it.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
region | Region | text | yes | no | The region this connection reaches. One connection covers one region. |
accountId | Account ID | text | no | yes | If supplied, the generated policy names the account instead of a wildcard. |
basePath | Base path | text | yes | no | The widest SSM path this connection may touch. Every sync scope will sit under it. |
What a mapping asks for
Answered once per environment you map.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
path | SSM path | text | yes | no | Maps onto this environment. Will sit under the connection's base path. |
recursive | Include nested paths | yes or no | yes | yes | Nested SSM paths become the parameter's path prefix with us. Starts at true. |
Permissions it needs
penv probes for these when it verifies the connection.
| Permission | Directions | Blocking | Without it |
|---|---|---|---|
sts:GetCallerIdentity | every direction | yes | We cannot confirm which IAM identity this credential is. |
ssm:GetParametersByPath | every direction | yes | Preview cannot list what is under this path. |
kms:Decrypt | import | no | SecureString parameters will import empty |
ssm:PutParameter | export | yes | Export cannot write anything. |
kms:Encrypt | export | yes | Export cannot write SecureString parameters. |
ssm:DeleteParameter | export | no | The overwrite_and_prune policy cannot remove remote keys. |