Class: Aws::IoT::Types::HttpAction

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass HttpAction data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authTypes::HttpAuthorization

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



9766
9767
9768
9769
9770
9771
9772
9773
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9766

class HttpAction < Struct.new(
  :url,
  :confirmation_url,
  :headers,
  :auth)
  SENSITIVE = []
  include Aws::Structure
end

#confirmation_urlString

The URL to which 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 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.

Returns:

  • (String)


9766
9767
9768
9769
9770
9771
9772
9773
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9766

class HttpAction < Struct.new(
  :url,
  :confirmation_url,
  :headers,
  :auth)
  SENSITIVE = []
  include Aws::Structure
end

#headersArray<Types::HttpActionHeader>

The HTTP headers to send with the message data.

Returns:



9766
9767
9768
9769
9770
9771
9772
9773
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9766

class HttpAction < Struct.new(
  :url,
  :confirmation_url,
  :headers,
  :auth)
  SENSITIVE = []
  include Aws::Structure
end

#urlString

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.

Returns:

  • (String)


9766
9767
9768
9769
9770
9771
9772
9773
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 9766

class HttpAction < Struct.new(
  :url,
  :confirmation_url,
  :headers,
  :auth)
  SENSITIVE = []
  include Aws::Structure
end