Class: Aws::IoT::Types::TopicRuleDestination

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::TopicRuleDestination

Defined in:

gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

A topic rule destination.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The topic rule destination URL.

• #created_at ⇒ Time

  The date and time when the topic rule destination was created.

• #http_url_properties ⇒ Types::HttpUrlDestinationProperties

  Properties of the HTTP URL.

• #influx_db_properties ⇒ Types::InfluxDBDestinationProperties

  The properties of an InfluxDB topic rule destination, as returned by CreateTopicRuleDestination and GetTopicRuleDestination.

• #last_updated_at ⇒ Time

  The date and time when the topic rule destination was last updated.

• #status ⇒ String

  The status of the topic rule destination.

• #status_reason ⇒ String

  Additional details or reason why the topic rule destination is in the current status.

• #vpc_properties ⇒ Types::VpcDestinationProperties

  Properties of the virtual private cloud (VPC) connection.

Instance Attribute Details

#arn ⇒ String

The topic rule destination URL.

Returns:

• (String)

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

class TopicRuleDestination < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_properties,
  :vpc_properties,
  :influx_db_properties)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when the topic rule destination was created.

Returns:

• (Time)

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

class TopicRuleDestination < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_properties,
  :vpc_properties,
  :influx_db_properties)
  SENSITIVE = []
  include Aws::Structure
end

#http_url_properties ⇒ Types::HttpUrlDestinationProperties

Properties of the HTTP URL.

Returns:

• (Types::HttpUrlDestinationProperties)

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

class TopicRuleDestination < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_properties,
  :vpc_properties,
  :influx_db_properties)
  SENSITIVE = []
  include Aws::Structure
end

#influx_db_properties ⇒ Types::InfluxDBDestinationProperties

The properties of an InfluxDB topic rule destination, as returned by CreateTopicRuleDestination and GetTopicRuleDestination.

Returns:

• (Types::InfluxDBDestinationProperties)

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

class TopicRuleDestination < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_properties,
  :vpc_properties,
  :influx_db_properties)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

The date and time when the topic rule destination was last updated.

Returns:

• (Time)

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

class TopicRuleDestination < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_properties,
  :vpc_properties,
  :influx_db_properties)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Returns:

• (String)

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

class TopicRuleDestination < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_properties,
  :vpc_properties,
  :influx_db_properties)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

Additional details or reason why the topic rule destination is in the current status.

Returns:

• (String)

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

class TopicRuleDestination < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_properties,
  :vpc_properties,
  :influx_db_properties)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_properties ⇒ Types::VpcDestinationProperties

Properties of the virtual private cloud (VPC) connection.

Returns:

• (Types::VpcDestinationProperties)

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

class TopicRuleDestination < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_properties,
  :vpc_properties,
  :influx_db_properties)
  SENSITIVE = []
  include Aws::Structure
end