AWS SSM Parameter Store (IAM role)

Move parameters to and from an SSM path through an IAM role you let us assume.

Connection

What	This provider
Vendor	Amazon Web Services
Key	`aws-ssm-role`
Availability	`available`. You can connect it today.
Credential we hold	`aws-role`
Values read back	yes
Activation	`immediate`

Directions

Direction	What it does
`import`	We read names and values out of the store into your environment.
`export`	We write names and values from your environment into the store.

Activation

immediate. The running app sees a new value at once.

Conflict policies

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.

Connect

You grant us access in your own AWS account. Pick one of these methods in the wizard.

We generate the shared value the grant is conditioned on, so you invent nothing.

CloudFormation: recommended, fastest and most secure

One pre-filled stack; your connection is live when it finishes. Follow a prepared link into the vendor's console. The vendor calls us back when the grant lands.

Set aside about 2 minutes.

Confirm you're signed into the AWS account you want to connect. Switch accounts first if you are not.
Open the pre-filled Create Stack page and tick the IAM acknowledgement.
Create the stack and leave this tab open; it flips to Connected on its own.

Terraform

Review the grant in code, then paste the role ARN back. Apply a rendered policy or template. You paste the result back into the wizard.

Set aside about 10 minutes.

Add the snippet to your AWS account's Terraform and apply it.
Paste the penv_role_arn output back here.

It gives you:

Name	Label	Kind	What it is
`snippet`	Terraform	read only, a block to copy
`externalId`	External ID	read only, filled in for you	Already baked into the snippet. Only we can assume the role with it.

You paste back:

Field	Label	Kind	Required	What it is
`roleArn`	Role ARN	text	yes	The ARN the grant printed. We assume it once to check it before saving.

Manual

Create the role manually from the two policies below. Set up the grant by hand in the vendor's console. You paste the result back into the wizard.

Set aside about 10 minutes.

In IAM, create a role for another AWS account and paste the trust policy below.
Attach the permissions policy below as an inline policy.
Paste the role's ARN back here.

It gives you:

Name	Label	Kind	What it is
`penvAccountId`	Our AWS account ID	read only, filled in for you	The account the role trusts.
`roleName`	Suggested role name	read only, filled in for you	Unique to this attempt, so it cannot collide with a role another connection made.
`externalId`	External ID	read only, filled in for you	Required in the trust policy. Only we can assume the role with it.
`trustPolicy`	Trust policy	read only, a block to copy
`permissionsPolicy`	Permissions policy	read only, a block to copy

You paste back:

Field	Label	Kind	Required	What it is
`roleArn`	Role ARN	text	yes	The ARN the grant printed. We assume it once to check it before saving.

Connection fields

You set these when you connect. Every mapping on the connection shares them.

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.
`roleArn`	Role ARN	read only, filled in for you	yes	no	The role we assume. We fill it in from the grant you completed.
`engineRoleArns`	Assumable engine roles	text	no	yes	Only for dynamic secrets, and fixed once the connection exists. Comma-separated role ARNs this connection may assume; leave empty to grant none.

Mapping fields

You answer these 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`.

Required permissions

We probe for these when we verify 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.

AWS SSM Parameter Store (IAM role)

On this page