Class MessageEnvelope

Namespace

AWS.Messaging

Assembly

AWS.Messaging.dll

Abstract MessageEnvelope containing all of the envelope information without the specific message. This class adheres to the CloudEvents specification v1.0 and contains all the attributes that are marked as required by the spec. The CloudEvent spec can be found here.

public abstract class MessageEnvelope

Inheritance

object

MessageEnvelope

Derived

MessageEnvelope<T>

Properties

DataContentType

The data content type.

[JsonPropertyName("datacontenttype")]
public string? DataContentType { get; set; }

Property Value

string

EventBridgeMetadata

Stores metadata related to Amazon EventBridge.

public EventBridgeMetadata? EventBridgeMetadata { get; set; }

Property Value

EventBridgeMetadata

Id

Specifies the envelope ID

[JsonPropertyName("id")]
public string Id { get; set; }

Property Value

string

MessageTypeIdentifier

The type of event that occurred. This represents the language agnostic type that is used to deserialize the envelope message into a .NET type.

[JsonPropertyName("type")]
public string MessageTypeIdentifier { get; set; }

Property Value

string

Metadata

This stores different metadata that is not modeled as a top-level property in MessageEnvelope class. These entries will also be serialized as top-level properties when sending the message, which can be used for CloudEvents Extension Attributes.

[JsonExtensionData]
public Dictionary<string, JsonElement> Metadata { get; set; }

Property Value

Dictionary<string, JsonElement>

SNSMetadata

Stores metadata related to Amazon SNS.

public SNSMetadata? SNSMetadata { get; set; }

Property Value

SNSMetadata

SQSMetadata

Stores metadata related to Amazon SQS.

public SQSMetadata? SQSMetadata { get; set; }

Property Value

SQSMetadata

Source

Specifies the source of the event. This can be the organization publishing the event or the process that produced the event.

[JsonPropertyName("source")]
public Uri Source { get; set; }

Property Value

Uri

TimeStamp

The timestamp when the event occurred.

[JsonPropertyName("time")]
public DateTimeOffset TimeStamp { get; set; }

Property Value

DateTimeOffset

Version

The version of the CloudEvents specification which the event uses.

[JsonPropertyName("specversion")]
public string Version { get; set; }

Property Value

string