Class: Aws::IoT::Types::TopicRuleDestinationSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::TopicRuleDestinationSummary

Defined in:

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

Overview

Information about the topic rule destination.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The topic rule destination ARN.

• #created_at ⇒ Time

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

• #http_url_summary ⇒ Types::HttpUrlDestinationSummary

  Information about the HTTP URL.

• #influx_db_summary ⇒ Types::InfluxDBDestinationSummary

  A summary of an InfluxDB topic rule destination, as returned by ListTopicRuleDestinations.

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

  The reason the topic rule destination is in the current status.

• #vpc_destination_summary ⇒ Types::VpcDestinationSummary

  Information about the virtual private cloud (VPC) connection.

Instance Attribute Details

#arn ⇒ String

The topic rule destination ARN.

Returns:

• (String)

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

class TopicRuleDestinationSummary < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_summary,
  :vpc_destination_summary,
  :influx_db_summary)
  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 17543

class TopicRuleDestinationSummary < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_summary,
  :vpc_destination_summary,
  :influx_db_summary)
  SENSITIVE = []
  include Aws::Structure
end

#http_url_summary ⇒ Types::HttpUrlDestinationSummary

Information about the HTTP URL.

Returns:

• (Types::HttpUrlDestinationSummary)

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

class TopicRuleDestinationSummary < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_summary,
  :vpc_destination_summary,
  :influx_db_summary)
  SENSITIVE = []
  include Aws::Structure
end

#influx_db_summary ⇒ Types::InfluxDBDestinationSummary

A summary of an InfluxDB topic rule destination, as returned by ListTopicRuleDestinations.

Returns:

• (Types::InfluxDBDestinationSummary)

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

class TopicRuleDestinationSummary < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_summary,
  :vpc_destination_summary,
  :influx_db_summary)
  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 17543

class TopicRuleDestinationSummary < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_summary,
  :vpc_destination_summary,
  :influx_db_summary)
  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 17543

class TopicRuleDestinationSummary < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_summary,
  :vpc_destination_summary,
  :influx_db_summary)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The reason the topic rule destination is in the current status.

Returns:

• (String)

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

class TopicRuleDestinationSummary < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_summary,
  :vpc_destination_summary,
  :influx_db_summary)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_destination_summary ⇒ Types::VpcDestinationSummary

Information about the virtual private cloud (VPC) connection.

Returns:

• (Types::VpcDestinationSummary)

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

class TopicRuleDestinationSummary < Struct.new(
  :arn,
  :status,
  :created_at,
  :last_updated_at,
  :status_reason,
  :http_url_summary,
  :vpc_destination_summary,
  :influx_db_summary)
  SENSITIVE = []
  include Aws::Structure
end