1.204.0

interface RepublishActionHeadersProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.RepublishActionHeadersProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.RepublishActionHeadersProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.RepublishActionHeadersProperty
TypeScript @aws-cdk/aws-iot » CfnTopicRule » RepublishActionHeadersProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iot from '@aws-cdk/aws-iot';
const republishActionHeadersProperty: iot.CfnTopicRule.RepublishActionHeadersProperty = {
  contentType: 'contentType',
  correlationData: 'correlationData',
  messageExpiry: 'messageExpiry',
  payloadFormatIndicator: 'payloadFormatIndicator',
  responseTopic: 'responseTopic',
  userProperties: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
contentType?stringA UTF-8 encoded string that describes the content of the publishing message.
correlationData?stringThe base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
messageExpiry?stringA user-defined integer value that represents the message expiry interval at the broker.
payloadFormatIndicator?stringAn Enum string value that indicates whether the payload is formatted as UTF-8.
responseTopic?stringA UTF-8 encoded string that's used as the topic name for a response message.
userProperties?IResolvable | IResolvable | UserPropertyProperty[]An array of key-value pairs that you define in the MQTT5 header.

contentType?

Type: string (optional)

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

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

Supports substitution templates .

correlationData?

Type: string (optional)

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

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

Supports substitution templates .

This binary data must be base64-encoded.

messageExpiry?

Type: string (optional)

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

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 .

payloadFormatIndicator?

Type: string (optional)

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

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 .

responseTopic?

Type: string (optional)

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

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 .

userProperties?

Type: IResolvable | IResolvable | UserPropertyProperty[] (optional)

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

← PreviousNext →