Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnTopicRulePropsMixin.HttpActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRulePropsMixin.HttpActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRulePropsMixin

@Stability(Stable)
public static interface CfnTopicRulePropsMixin.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.cfnpropertymixins.services.iot.*;
 HttpActionProperty httpActionProperty = HttpActionProperty.builder()
         .auth(HttpAuthorizationProperty.builder()
                 .sigv4(SigV4AuthorizationProperty.builder()
                         .roleArn("roleArn")
                         .serviceName("serviceName")
                         .signingRegion("signingRegion")
                         .build())
                 .build())
         .batchConfig(BatchConfigProperty.builder()
                 .maxBatchOpenMs(123)
                 .maxBatchSize(123)
                 .maxBatchSizeBytes(123)
                 .build())
         .confirmationUrl("confirmationUrl")
         .enableBatching(false)
         .headers(List.of(HttpActionHeaderProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .url("url")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRulePropsMixin.HttpActionProperty.Builder	builder()
default Object	getAuth()	The authentication method to use when sending data to an HTTPS endpoint.
default Object	getBatchConfig()	Returns union: either IResolvable or CfnTopicRulePropsMixin.BatchConfigProperty
default String	getConfirmationUrl()	The URL to which AWS IoT sends a confirmation message.
default Object	getEnableBatching()	Returns union: either Boolean or IResolvable
default Object	getHeaders()	The HTTP headers to send with the message data.
default String	getUrl()	The endpoint URL.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuth

@Stability(Stable)
@Nullable
default Object getAuth()

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

Returns union: either IResolvable or CfnTopicRulePropsMixin.HttpAuthorizationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-auth

getBatchConfig

@Stability(Stable)
@Nullable
default Object getBatchConfig()

Returns union: either IResolvable or CfnTopicRulePropsMixin.BatchConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-batchconfig

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-confirmationurl

getEnableBatching

@Stability(Stable)
@Nullable
default Object getEnableBatching()

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-enablebatching

getHeaders

@Stability(Stable)
@Nullable
default Object getHeaders()

The HTTP headers to send with the message data.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopicRulePropsMixin.HttpActionHeaderProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-headers

getUrl

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-url

builder

@Stability(Stable)
static CfnTopicRulePropsMixin.HttpActionProperty.Builder builder()

Returns:

a CfnTopicRulePropsMixin.HttpActionProperty.Builder of CfnTopicRulePropsMixin.HttpActionProperty