AWS SNS binding spec

Detailed documentation on the AWS SNS binding component

Component format

To setup AWS SNS binding create a component of type bindings.aws.sns. See this guide on how to create and apply a binding configuration.

See Authenticating to AWS for information about authentication-related attributes

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5. spec:
  6.   type: bindings.aws.sns
  7.   version: v1
  8.   metadata:
  9.   - name: topicArn
  10.     value: "mytopic"
  11.   - name: region
  12.     value: "us-west-2"
  13.   - name: endpoint
  14.     value: "sns.us-west-2.amazonaws.com"
  15.   - name: accessKey
  16.     value: "*****************"
  17.   - name: secretKey
  18.     value: "*****************"
  19.   - name: sessionToken
  20.     value: "*****************"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

FieldRequiredBinding supportDetailsExample
topicArnYOutputThe SNS topic name“arn:::topicarn”
regionYOutputThe specific AWS region“us-east-1”
endpointNOutputThe specific AWS endpoint“sns.us-east-1.amazonaws.com”
accessKeyYOutputThe AWS Access Key to access this resource“key”
secretKeyYOutputThe AWS Secret Access Key to access this resource“secretAccessKey”
sessionTokenNOutputThe AWS session token to use“sessionToken”

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.

Binding support

This component supports output binding with the following operations:

  • create

Last modified October 11, 2024: Fixed typo (#4389) (fe17926)