AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::TopicRuleDestinationSummary

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about the topic rule destination.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The topic rule destination ARN.

Returns:

  • (String)

    The topic rule destination ARN.

#http_url_summaryTypes::HttpUrlDestinationSummary

Information about the HTTP URL.

Returns:

#statusString

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Possible values:

  • ENABLED
  • IN_PROGRESS
  • DISABLED
  • ERROR

Returns:

  • (String)

    The status of the topic rule destination.

#status_reasonString

The reason the topic rule destination is in the current status.

Returns:

  • (String)

    The reason the topic rule destination is in the current status.