Interface CfnTopicRule.IHttpActionProperty
Send data to an HTTPS endpoint.
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IHttpActionProperty
Syntax (vb)
Public Interface IHttpActionProperty
Remarks
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.AWS.IoT;
var httpActionProperty = new HttpActionProperty {
Url = "url",
// the properties below are optional
Auth = new HttpAuthorizationProperty {
Sigv4 = new SigV4AuthorizationProperty {
RoleArn = "roleArn",
ServiceName = "serviceName",
SigningRegion = "signingRegion"
}
},
ConfirmationUrl = "confirmationUrl",
Headers = new [] { new HttpActionHeaderProperty {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
Auth | The authentication method to use when sending data to an HTTPS endpoint. |
ConfirmationUrl | The URL to which AWS IoT sends a confirmation message. |
Headers | The HTTP headers to send with the message data. |
Url | The endpoint URL. |
Properties
Auth
The authentication method to use when sending data to an HTTPS endpoint.
virtual object Auth { get; }
Property Value
System.Object
Remarks
ConfirmationUrl
The URL to which AWS IoT sends a confirmation message.
virtual string ConfirmationUrl { get; }
Property Value
System.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.
Headers
The HTTP headers to send with the message data.
virtual object Headers { get; }
Property Value
System.Object
Remarks
Url
The endpoint URL.
string Url { get; }
Property Value
System.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.