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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::HttpAction

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Send data to an HTTPS endpoint.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auth ⇒ Types::HttpAuthorization

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

• #batch_config ⇒ Types::BatchConfig

  The configuration settings for batching.

• #confirmation_url ⇒ String

  The URL to which IoT sends a confirmation message.

• #enable_batching ⇒ Boolean

  Whether to process the HTTP action messages into a single request.

• #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.

Returns:

• (Types::HttpAuthorization)

# File 'lib/aws-sdk-iot/types.rb', line 9104

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

#batch_config ⇒ Types::BatchConfig

The configuration settings for batching. For more information, see [ Batching HTTP action messages].

[1]: docs.aws.amazon.com/iot/latest/developerguide/http_batching.html

Returns:

• (Types::BatchConfig)

# File 'lib/aws-sdk-iot/types.rb', line 9104

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

#confirmation_url ⇒ String

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)

# File 'lib/aws-sdk-iot/types.rb', line 9104

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

#enable_batching ⇒ Boolean

Whether to process the HTTP action messages into a single request. Value can be true or false.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 9104

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

#headers ⇒ Array<Types::HttpActionHeader>

The HTTP headers to send with the message data.

Returns:

• (Array<Types::HttpActionHeader>)

# File 'lib/aws-sdk-iot/types.rb', line 9104

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

#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.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 9104

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