AWS::IoT::TopicRuleDestination - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoT::TopicRuleDestination

A topic rule destination.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoT::TopicRuleDestination",
  "Properties" : {
      "HttpUrlProperties" : HttpUrlDestinationSummary,
      "Status" : String,
      "VpcProperties" : VpcDestinationProperties
    }
}

YAML

Type: AWS::IoT::TopicRuleDestination
Properties:
  HttpUrlProperties: 
    HttpUrlDestinationSummary
  Status: String
  VpcProperties: 
    VpcDestinationProperties

Properties

HttpUrlProperties

Properties of the HTTP URL.

Required: No

Type: HttpUrlDestinationSummary

Update requires: Replacement

Status
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.

Required: No

Type: String

Allowed values: ENABLED | IN_PROGRESS | DISABLED

Update requires: No interruption

VpcProperties

Properties of the virtual private cloud (VPC) connection.

Required: No

Type: VpcDestinationProperties

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the topic rule destination. For example:

{ "Ref": "TopicRuleDestination" }

A value similar to the following is returned:

a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

For more information about using the Ref function, see Ref.

Fn::GetAtt

Arn

The topic rule destination URL.

StatusReason

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