Skip to main content

AWS SNS

Type: bindings.aws.sns

Status: alpha

Reference: https://docs.dapr.io/reference/components-reference/supported-bindings/sns/

Example​

apiVersion: cra.diagrid.io/v1beta1
kind: Component
metadata:
  name: <name>
spec:
  type: bindings.aws.sns
  version: v1
  metadata:
    # AWS access key associated with an IAM account
    - name: accessKey
      value: "AKIAIOSFODNN7EXAMPLE"
    # The AWS Region where the AWS resource is deployed to.
    - name: awsRegion
      value: "us-east-1"
    # The secret key associated with the access key
    - name: secretKey
      value: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    # AWS session token to use. A session token is only required if you are using temporary security credentials. (Optional)
    #- name: sessionToken
    #  value: "TOKEN"
    # The SNS topic name.
    - name: topicArn
      value: "arn:::topicarn"
    # AWS endpoint for the component to use, to connect to SNS-compatible services or emulators. Do not use this when running against production AWS. (Optional)
    #- name: endpoint
    #  value: "http://mycompany.com:4566"

Binding information​

Input Binding: no

Output Binding: yes

Output Binding operations:​

  • create: Create a new subscription

Authentication profiles​

Available authentication profiles:

  • AWS: Access Key ID and Secret Access Key

AWS: Access Key ID and Secret Access Key​

Authenticate using an Access Key ID and Secret Access Key included in the metadata

accessKey​

Required - AWS access key associated with an IAM account

Example value: AKIAIOSFODNN7EXAMPLE

awsRegion (string)​

Required - The AWS Region where the AWS resource is deployed to.

Example value: us-east-1

secretKey​

Required - The secret key associated with the access key

Example value: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

sessionToken (string)​

AWS session token to use. A session token is only required if you are using temporary security credentials.

Example value: TOKEN

Metadata​

topicArn (string)​

Required - The SNS topic name.

Example value: arn:::topicarn

endpoint (string)​

AWS endpoint for the component to use, to connect to SNS-compatible services or emulators. Do not use this when running against production AWS.

Example value: http://mycompany.com:4566