Class: Aws::IoT::Types::RepublishAction

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::RepublishAction

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass RepublishAction data as a hash:

{
  role_arn: "AwsArn", # required
  topic: "TopicPattern", # required
  qos: 1,
  headers: {
    payload_format_indicator: "PayloadFormatIndicator",
    content_type: "ContentType",
    response_topic: "ResponseTopic",
    correlation_data: "CorrelationData",
    message_expiry: "MessageExpiry",
    user_properties: [
      {
        key: "UserPropertyKey", # required
        value: "UserPropertyValue", # required
      },
    ],
  },
}

Describes an action to republish to another topic.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #headers ⇒ Types::MqttHeaders

  MQTT Version 5.0 headers information.

• #qos ⇒ Integer

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

• #role_arn ⇒ String

  The ARN of the IAM role that grants access.

• #topic ⇒ String

  The name of the MQTT topic.

Instance Attribute Details

#headers ⇒ Types::MqttHeaders

MQTT Version 5.0 headers information. For more information, see [ MQTT] from the Amazon Web Services IoT Core Developer Guide.

[1]: docs.aws.amazon.com/iot/latest/developerguide/mqtt.html

Returns:

• (Types::MqttHeaders)

# File 'lib/aws-sdk-iot/types.rb', line 16384

class RepublishAction < Struct.new(
  :role_arn,
  :topic,
  :qos,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#qos ⇒ Integer

The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

Returns:

• (Integer)

# File 'lib/aws-sdk-iot/types.rb', line 16384

class RepublishAction < Struct.new(
  :role_arn,
  :topic,
  :qos,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the IAM role that grants access.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 16384

class RepublishAction < Struct.new(
  :role_arn,
  :topic,
  :qos,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end

#topic ⇒ String

The name of the MQTT topic.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 16384

class RepublishAction < Struct.new(
  :role_arn,
  :topic,
  :qos,
  :headers)
  SENSITIVE = []
  include Aws::Structure
end