Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.HttpActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.HttpActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.HttpActionProperty
extends software.amazon.jsii.JsiiSerializable

Send data to an HTTPS endpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 HttpActionProperty httpActionProperty = HttpActionProperty.builder()
         .url("url")
         // the properties below are optional
         .auth(HttpAuthorizationProperty.builder()
                 .sigv4(SigV4AuthorizationProperty.builder()
                         .roleArn("roleArn")
                         .serviceName("serviceName")
                         .signingRegion("signingRegion")
                         .build())
                 .build())
         .confirmationUrl("confirmationUrl")
         .headers(List.of(HttpActionHeaderProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTopicRule.HttpActionProperty.Builder	A builder for CfnTopicRule.HttpActionProperty
static final class	CfnTopicRule.HttpActionProperty.Jsii$Proxy	An implementation for CfnTopicRule.HttpActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.HttpActionProperty.Builder	builder()
default Object	getAuth()	The authentication method to use when sending data to an HTTPS endpoint.
default String	getConfirmationUrl()	The URL to which AWS IoT sends a confirmation message.
default Object	getHeaders()	The HTTP headers to send with the message data.
String	getUrl()	The endpoint URL.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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()

Returns:

a CfnTopicRule.HttpActionProperty.Builder of CfnTopicRule.HttpActionProperty