Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.RepublishActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.RepublishActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.RepublishActionProperty
extends software.amazon.jsii.JsiiSerializable

Describes an action to republish to another topic.

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.*;
 RepublishActionProperty republishActionProperty = RepublishActionProperty.builder()
         .roleArn("roleArn")
         .topic("topic")
         // the properties below are optional
         .headers(RepublishActionHeadersProperty.builder()
                 .contentType("contentType")
                 .correlationData("correlationData")
                 .messageExpiry("messageExpiry")
                 .payloadFormatIndicator("payloadFormatIndicator")
                 .responseTopic("responseTopic")
                 .userProperties(List.of(UserPropertyProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .qos(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.RepublishActionProperty.Builder	builder()
default Object	getHeaders()	MQTT Version 5.0 headers information.
default Number	getQos()	The Quality of Service (QoS) level to use when republishing messages.
String	getRoleArn()	The ARN of the IAM role that grants access.
String	getTopic()	The name of the MQTT topic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the IAM role that grants access.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-rolearn

getTopic

@Stability(Stable)
@NotNull
String getTopic()

The name of the MQTT topic.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-topic

getHeaders

@Stability(Stable)
@Nullable
default Object getHeaders()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-headers

getQos

@Stability(Stable)
@Nullable
default Number getQos()

The Quality of Service (QoS) level to use when republishing messages.

The default value is 0.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-qos

builder

@Stability(Stable)
static CfnTopicRule.RepublishActionProperty.Builder builder()

Returns:

a CfnTopicRule.RepublishActionProperty.Builder of CfnTopicRule.RepublishActionProperty