AWS SSM Parameter Store

Detailed information on the AWS SSM Parameter Store - secret store component

Component format

To setup AWS SSM Parameter Store secret store create a component of type secretstores.aws.parameterstore. See this guide on how to create and apply a secretstore configuration. See this guide on referencing secrets to retrieve and use the secret with Dapr components.

See Authenticating to AWS for information about authentication-related attributes.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: awsparameterstore
  5. spec:
  6.   type: secretstores.aws.parameterstore
  7.   version: v1
  8.   metadata:
  9.   - name: region
  10.     value: "[aws_region]"
  11.   - name: accessKey
  12.     value: "[aws_access_key]"
  13.   - name: secretKey
  14.     value: "[aws_secret_key]"
  15.   - name: sessionToken
  16.     value: "[aws_session_token]"
  17.   - name: prefix
  18.     value: "[secret_name]"

Warning

The above example uses secrets as plain strings. It is recommended to use a local secret store such as Kubernetes secret store or a local file to bootstrap secure key storage.

Spec metadata fields

FieldRequiredDetailsExample
regionYThe specific AWS region the AWS SSM Parameter Store instance is deployed in“us-east-1”
accessKeyYThe AWS Access Key to access this resource“key”
secretKeyYThe AWS Secret Access Key to access this resource“secretAccessKey”
sessionTokenNThe AWS session token to use“sessionToken”
prefixNAllows you to specify more than one SSM parameter store secret store component.“prefix”

Important

When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you’re using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you must not provide AWS access-key, secret-key, and tokens in the definition of the component spec you’re using.

Create an AWS SSM Parameter Store instance

Setup AWS SSM Parameter Store using the AWS documentation: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html.

Last modified March 21, 2024: Merge pull request #4082 from newbe36524/v1.13 (f4b0938)