Package software.amazon.awscdk.services.iot.actions.alpha

Interface HttpsActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpsActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-23T11:20:10.155Z")
@Stability(Experimental)
public interface HttpsActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

(experimental) Configuration properties of an HTTPS action.

Example:

 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"))
         .build();
 topicRule.addAction(
 HttpsAction.Builder.create("https://example.com/endpoint")
         .confirmationUrl("https://example.com")
         .headers(List.of(HttpActionHeader.builder().key("key0").value("value0").build(), HttpActionHeader.builder().key("key1").value("value1").build()))
         .auth(HttpActionSigV4Auth.builder().serviceName("serviceName").signingRegion("us-east-1").build())
         .build());
 

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/https-rule-action.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpsActionProps.Builder	builder()
default HttpActionSigV4Auth	getAuth()	(experimental) Use Sigv4 authorization.
default HttpActionBatchConfig	getBatchConfig()	(experimental) Configuration for batching HTTP action messages.
default String	getConfirmationUrl()	(experimental) If specified, AWS IoT uses the confirmation URL to create a matching topic rule destination.
default List<HttpActionHeader>	getHeaders()	(experimental) The headers to include in the HTTPS request to the endpoint.

Methods inherited from interface software.amazon.awscdk.services.iot.actions.alpha.CommonActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuth

@Stability(Experimental)
@Nullable
default HttpActionSigV4Auth getAuth()

(experimental) Use Sigv4 authorization.

getBatchConfig

@Stability(Experimental)
@Nullable
default HttpActionBatchConfig getBatchConfig()

(experimental) Configuration for batching HTTP action messages.

When provided, batching is automatically enabled.

Default: - Batching is disabled

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/http_batching.html

getConfirmationUrl

@Stability(Experimental)
@Nullable
default String getConfirmationUrl()

(experimental) If specified, AWS IoT uses the confirmation URL to create a matching topic rule destination.

getHeaders

@Stability(Experimental)
@Nullable
default List<HttpActionHeader> getHeaders()

(experimental) The headers to include in the HTTPS request to the endpoint.

builder

@Stability(Experimental)
static HttpsActionProps.Builder builder()

Returns:

a HttpsActionProps.Builder of HttpsActionProps