TopicRuleDestination - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

TopicRuleDestination

A topic rule destination.

Contents

arn

The topic rule destination URL.

Type: String

Required: No

createdAt

The date and time when the topic rule destination was created.

Type: Timestamp

Required: No

httpUrlProperties

Properties of the HTTP URL.

Type: HttpUrlDestinationProperties object

Required: No

lastUpdatedAt

The date and time when the topic rule destination was last updated.

Type: Timestamp

Required: No

status

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.

Type: String

Valid Values: ENABLED | IN_PROGRESS | DISABLED | ERROR | DELETING

Required: No

statusReason

Additional details or reason why the topic rule destination is in the current status.

Type: String

Required: No

vpcProperties

Properties of the virtual private cloud (VPC) connection.

Type: VpcDestinationProperties object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: