Class CfnTopicRulePropsMixin.RepublishActionHeadersProperty

Specifies MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.

Inheritance

object

CfnTopicRulePropsMixin.RepublishActionHeadersProperty

Implements

CfnTopicRulePropsMixin.IRepublishActionHeadersProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoT

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnTopicRulePropsMixin.RepublishActionHeadersProperty : CfnTopicRulePropsMixin.IRepublishActionHeadersProperty

Syntax (vb)

Public Class CfnTopicRulePropsMixin.RepublishActionHeadersProperty Implements CfnTopicRulePropsMixin.IRepublishActionHeadersProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoT;

             var republishActionHeadersProperty = new RepublishActionHeadersProperty {
                 ContentType = "contentType",
                 CorrelationData = "correlationData",
                 MessageExpiry = "messageExpiry",
                 PayloadFormatIndicator = "payloadFormatIndicator",
                 ResponseTopic = "responseTopic",
                 UserProperties = new [] { new UserPropertyProperty {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

RepublishActionHeadersProperty()

Specifies MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.

Properties

ContentType	A UTF-8 encoded string that describes the content of the publishing message.
CorrelationData	The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
MessageExpiry	A user-defined integer value that represents the message expiry interval at the broker.
PayloadFormatIndicator	An `Enum` string value that indicates whether the payload is formatted as UTF-8.
ResponseTopic	A UTF-8 encoded string that's used as the topic name for a response message.
UserProperties	An array of key-value pairs that you define in the MQTT5 header.

Constructors

RepublishActionHeadersProperty()

Specifies MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.

public RepublishActionHeadersProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoT;

             var republishActionHeadersProperty = new RepublishActionHeadersProperty {
                 ContentType = "contentType",
                 CorrelationData = "correlationData",
                 MessageExpiry = "messageExpiry",
                 PayloadFormatIndicator = "payloadFormatIndicator",
                 ResponseTopic = "responseTopic",
                 UserProperties = new [] { new UserPropertyProperty {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

ContentType

A UTF-8 encoded string that describes the content of the publishing message.

public string? ContentType { get; set; }

Property Value

string

Remarks

For more information, see Content Type in the MQTT Version 5.0 specification.

Supports substitution templates .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-contenttype

CorrelationData

The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.

public string? CorrelationData { get; set; }

Property Value

string

Remarks

For more information, see Correlation Data in the MQTT Version 5.0 specification.

Supports substitution templates .

This binary data must be base64-encoded.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-correlationdata

MessageExpiry

A user-defined integer value that represents the message expiry interval at the broker.

public string? MessageExpiry { get; set; }

Property Value

string

Remarks

If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of messageExpiry represents the number of seconds before it expires. For more information about the limits of messageExpiry , see Message broker and protocol limits and quotas in the IoT Core Reference Guide.

Supports substitution templates .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-messageexpiry

PayloadFormatIndicator

An Enum string value that indicates whether the payload is formatted as UTF-8.

public string? PayloadFormatIndicator { get; set; }

Property Value

string

Remarks

Valid values are UNSPECIFIED_BYTES and UTF8_DATA .

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-payloadformatindicator

ResponseTopic

A UTF-8 encoded string that's used as the topic name for a response message.

public string? ResponseTopic { get; set; }

Property Value

string

Remarks

The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.

For more information, see Response Topic in the MQTT Version 5.0 specification.

Supports substitution templates .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html#cfn-iot-topicrule-republishactionheaders-responsetopic

UserProperties

An array of key-value pairs that you define in the MQTT5 header.

public object? UserProperties { get; set; }