Class CfnTopicRulePropsMixin.HttpActionProperty

Send data to an HTTPS endpoint.

Inheritance

object

CfnTopicRulePropsMixin.HttpActionProperty

Implements

CfnTopicRulePropsMixin.IHttpActionProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoT

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnTopicRulePropsMixin.HttpActionProperty : CfnTopicRulePropsMixin.IHttpActionProperty

Syntax (vb)

Public Class CfnTopicRulePropsMixin.HttpActionProperty Implements CfnTopicRulePropsMixin.IHttpActionProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoT;

             var httpActionProperty = new HttpActionProperty {
                 Auth = new HttpAuthorizationProperty {
                     Sigv4 = new SigV4AuthorizationProperty {
                         RoleArn = "roleArn",
                         ServiceName = "serviceName",
                         SigningRegion = "signingRegion"
                     }
                 },
                 BatchConfig = new BatchConfigProperty {
                     MaxBatchOpenMs = 123,
                     MaxBatchSize = 123,
                     MaxBatchSizeBytes = 123
                 },
                 ConfirmationUrl = "confirmationUrl",
                 EnableBatching = false,
                 Headers = new [] { new HttpActionHeaderProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 Url = "url"
             };

Synopsis

Constructors

HttpActionProperty()

Send data to an HTTPS endpoint.

Properties

Auth	The authentication method to use when sending data to an HTTPS endpoint.
BatchConfig	Send data to an HTTPS endpoint.
ConfirmationUrl	The URL to which AWS IoT sends a confirmation message.
EnableBatching	Send data to an HTTPS endpoint.
Headers	The HTTP headers to send with the message data.
Url	The endpoint URL.

Constructors

HttpActionProperty()

Send data to an HTTPS endpoint.

public HttpActionProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoT;

             var httpActionProperty = new HttpActionProperty {
                 Auth = new HttpAuthorizationProperty {
                     Sigv4 = new SigV4AuthorizationProperty {
                         RoleArn = "roleArn",
                         ServiceName = "serviceName",
                         SigningRegion = "signingRegion"
                     }
                 },
                 BatchConfig = new BatchConfigProperty {
                     MaxBatchOpenMs = 123,
                     MaxBatchSize = 123,
                     MaxBatchSizeBytes = 123
                 },
                 ConfirmationUrl = "confirmationUrl",
                 EnableBatching = false,
                 Headers = new [] { new HttpActionHeaderProperty {
                     Key = "key",
                     Value = "value"
                 } },
                 Url = "url"
             };

Properties

Auth

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

public object? Auth { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnTopicRulePropsMixin.IHttpAuthorizationProperty

BatchConfig

Send data to an HTTPS endpoint.

public object? BatchConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnTopicRulePropsMixin.IBatchConfigProperty

ConfirmationUrl

The URL to which AWS IoT sends a confirmation message.

public string? ConfirmationUrl { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-confirmationurl

EnableBatching

Send data to an HTTPS endpoint.

public object? EnableBatching { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

Headers

The HTTP headers to send with the message data.

public object? Headers { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnTopicRulePropsMixin.IHttpActionHeaderProperty)[]

Url

The endpoint URL.

public string? Url { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-url

Implements

CfnTopicRulePropsMixin.IHttpActionProperty