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

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

Overview

A topic rule destination.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The topic rule destination URL.

Returns:

  • (String)


18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18288

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

#created_atTime

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

Returns:

  • (Time)


18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18288

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

#http_url_propertiesTypes::HttpUrlDestinationProperties

Properties of the HTTP URL.



18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18288

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

#last_updated_atTime

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

Returns:

  • (Time)


18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18288

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

#statusString

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)


18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18288

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

#status_reasonString

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

Returns:

  • (String)


18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18288

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

#vpc_propertiesTypes::VpcDestinationProperties

Properties of the virtual private cloud (VPC) connection.



18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 18288

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