Interface CfnTopicRule.HttpActionProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnTopicRule.HttpActionProperty extends
Send data to an HTTPS endpoint.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 HttpActionProperty httpActionProperty = HttpActionProperty.builder()
         // the properties below are optional
  • Method Details

    • getUrl

      @Stability(Stable) @NotNull String getUrl()
      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.

    • getAuth

      @Stability(Stable) @Nullable default Object getAuth()
      The authentication method to use when sending data to an HTTPS endpoint.
    • getConfirmationUrl

      @Stability(Stable) @Nullable default String getConfirmationUrl()
      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.

    • getHeaders

      @Stability(Stable) @Nullable default Object getHeaders()
      The HTTP headers to send with the message data.
    • builder

      @Stability(Stable) static CfnTopicRule.HttpActionProperty.Builder builder()
      a CfnTopicRule.HttpActionProperty.Builder of CfnTopicRule.HttpActionProperty