Amazon SQS Message Binding v0.3.0
The SQS message binding object is reserved for future use. It is intended to hold message-level configuration settings for SQS, but currently, it does not define any properties.
Overview
While you can include a SQS message binding in your AsyncAPI document, it serves only as a placeholder. There are no SQS-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
.
Property | Type | Description |
---|---|---|
bindingVersion | string | The version of this binding. For v0.3.0 , this MUST be 0.3.0 . |
Example
Although the binding has no effect, you can still include it in your message definition.
messages:
userSignedUp:
payload:
type: object
properties:
email:
type: string
format: email
bindings:
sqs:
bindingVersion: '0.3.0'
Use Cases
As this binding is a placeholder, it has no direct use cases at this time. It is included in the specification to allow for future enhancements without introducing breaking changes.
Versioning
This binding is for version 0.3.0
of the SQS binding specification.