AWS::IoT::TopicRule HttpAction

Send data to an HTTPS endpoint.

Syntax

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

JSON

{
  "Auth" : HttpAuthorization,
  "ConfirmationUrl" : String,
  "Headers" : [ HttpActionHeader, ... ],
  "Url" : String
}

YAML

  Auth: 
    HttpAuthorization
  ConfirmationUrl: String
  Headers: 
    - HttpActionHeader
  Url: String

Properties

Auth

The authentication method to use when sending data to an HTTPS endpoint.

Required: No

Type: HttpAuthorization

Update requires: No interruption

ConfirmationUrl

The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

Required: No

Type: String

Update requires: No interruption

Headers

The HTTP headers to send with the message data.

Required: No

Type: Array of HttpActionHeader

Update requires: No interruption

Url

The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

Required: Yes

Type: String

Update requires: No interruption