software.amazon.awscdk.services.iot

Interface CfnTopicRule.RepublishActionHeadersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.RepublishActionHeadersProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(value=Stable)
public static interface CfnTopicRule.RepublishActionHeadersProperty
extends software.amazon.jsii.JsiiSerializable

Specifies MQTT Version 5.0 headers information. For more information, see [MQTT](https://docs.aws.amazon.com//iot/latest/developerguide/mqtt.html) 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 software.amazon.awscdk.services.iot.*;
 RepublishActionHeadersProperty republishActionHeadersProperty = RepublishActionHeadersProperty.builder()
         .contentType("contentType")
         .correlationData("correlationData")
         .messageExpiry("messageExpiry")
         .payloadFormatIndicator("payloadFormatIndicator")
         .responseTopic("responseTopic")
         .userProperties(List.of(UserPropertyProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTopicRule.RepublishActionHeadersProperty.Builder A builder for CfnTopicRule.RepublishActionHeadersProperty
static class	CfnTopicRule.RepublishActionHeadersProperty.Jsii$Proxy An implementation for CfnTopicRule.RepublishActionHeadersProperty

Method Summary

Modifier and Type	Method and Description
static CfnTopicRule.RepublishActionHeadersProperty.Builder	builder()
default String	getContentType() A UTF-8 encoded string that describes the content of the publishing message.
default String	getCorrelationData() The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
default String	getMessageExpiry() A user-defined integer value that represents the message expiry interval at the broker.
default String	getPayloadFormatIndicator() An `Enum` string value that indicates whether the payload is formatted as UTF-8.
default String	getResponseTopic() A UTF-8 encoded string that's used as the topic name for a response message.
default Object	getUserProperties() An array of key-value pairs that you define in the MQTT5 header.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContentType

@Stability(value=Stable)
 @Nullable
default String getContentType()

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 .

getCorrelationData

@Stability(value=Stable)
 @Nullable
default String getCorrelationData()

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.

getMessageExpiry

@Stability(value=Stable)
 @Nullable
default String getMessageExpiry()

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 .

getPayloadFormatIndicator

@Stability(value=Stable)
 @Nullable
default String getPayloadFormatIndicator()

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 .

getResponseTopic

@Stability(value=Stable)
 @Nullable
default String getResponseTopic()

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 .

getUserProperties

@Stability(value=Stable)
 @Nullable
default Object getUserProperties()

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

builder

@Stability(value=Stable)
static CfnTopicRule.RepublishActionHeadersProperty.Builder builder()

Returns:

a CfnTopicRule.RepublishActionHeadersProperty.Builder of CfnTopicRule.RepublishActionHeadersProperty