You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::HttpAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::HttpAction
- Defined in:
- (unknown)
Overview
When passing HttpAction as input to an Aws::Client method, you can use a vanilla Hash:
{
url: "Url", # required
confirmation_url: "Url",
headers: [
{
key: "HeaderKey", # required
value: "HeaderValue", # required
},
],
auth: {
sigv4: {
signing_region: "SigningRegion", # required
service_name: "ServiceName", # required
role_arn: "AwsArn", # required
},
},
}
Send data to an HTTPS endpoint.
Returned by:
Instance Attribute Summary collapse
-
#auth ⇒ Types::HttpAuthorization
The authentication method to use when sending data to an HTTPS endpoint.
-
#confirmation_url ⇒ String
The URL to which AWS IoT sends a confirmation message.
-
#headers ⇒ Array<Types::HttpActionHeader>
The HTTP headers to send with the message data.
-
#url ⇒ String
The endpoint URL.
Instance Attribute Details
#auth ⇒ Types::HttpAuthorization
The authentication method to use when sending data to an HTTPS endpoint.
#confirmation_url ⇒ String
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.
#headers ⇒ Array<Types::HttpActionHeader>
The HTTP headers to send with the message data.
#url ⇒ String
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.