Skip to content

Amazon SNS Message Binding v0.2.0

The SNS message binding object is reserved for future use. It is intended to hold message-level configuration settings for SNS, but currently, it does not define any properties.

Overview

While you can include an SNS message binding in your AsyncAPI document, it serves only as a placeholder. There are no SNS-specific message properties to configure in this version of the binding.

Message Properties

This binding object is currently empty and has no properties other than bindingVersion.

PropertyTypeDescription
bindingVersionstringThe version of this binding. For v0.2.0, this MUST be 0.2.0.

Example

Although the binding has no effect, you can still include it in your message definition.

yaml
messages:
  userSignedUp:
    payload:
      type: object
      properties:
        email:
          type: string
          format: email
    bindings:
      sns:
        bindingVersion: '0.2.0'

Migration from v0.1.0

There are no breaking changes when migrating from v0.1.0 to v0.2.0, as the message binding object remains a placeholder in both versions.