Amazonka.IoT.Types.TopicRuleDestination

Documentation

data TopicRuleDestination

A topic rule destination.

See: newTopicRuleDestination smart constructor.

Constructors

TopicRuleDestination'

Fields

• arn :: Maybe Text

  The topic rule destination URL.

• createdAt :: Maybe POSIX

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

• httpUrlProperties :: Maybe HttpUrlDestinationProperties

  Properties of the HTTP URL.

• lastUpdatedAt :: Maybe POSIX

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

• status :: Maybe TopicRuleDestinationStatus

  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.

• statusReason :: Maybe Text

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

• vpcProperties :: Maybe VpcDestinationProperties

  Properties of the virtual private cloud (VPC) connection.

Instances

FromJSON TopicRuleDestination

Defined in Amazonka.IoT.Types.TopicRuleDestination

Methods

parseJSON :: Value -> Parser TopicRuleDestination

parseJSONList :: Value -> Parser [TopicRuleDestination]

Generic TopicRuleDestination

Defined in Amazonka.IoT.Types.TopicRuleDestination

Associated Types

type Rep TopicRuleDestination :: Type -> Type

Methods

from :: TopicRuleDestination -> Rep TopicRuleDestination x

to :: Rep TopicRuleDestination x -> TopicRuleDestination

Read TopicRuleDestination

Defined in Amazonka.IoT.Types.TopicRuleDestination

Methods

readsPrec :: Int -> ReadS TopicRuleDestination

readList :: ReadS [TopicRuleDestination]

readPrec :: ReadPrec TopicRuleDestination

readListPrec :: ReadPrec [TopicRuleDestination]

Show TopicRuleDestination

Defined in Amazonka.IoT.Types.TopicRuleDestination

Methods

showsPrec :: Int -> TopicRuleDestination -> ShowS

show :: TopicRuleDestination -> String

showList :: [TopicRuleDestination] -> ShowS

NFData TopicRuleDestination

Defined in Amazonka.IoT.Types.TopicRuleDestination

Methods

rnf :: TopicRuleDestination -> ()

Eq TopicRuleDestination

Defined in Amazonka.IoT.Types.TopicRuleDestination

Methods

(==) :: TopicRuleDestination -> TopicRuleDestination -> Bool

(/=) :: TopicRuleDestination -> TopicRuleDestination -> Bool

Hashable TopicRuleDestination

Defined in Amazonka.IoT.Types.TopicRuleDestination

Methods

hashWithSalt :: Int -> TopicRuleDestination -> Int

hash :: TopicRuleDestination -> Int

type Rep TopicRuleDestination

Defined in Amazonka.IoT.Types.TopicRuleDestination

type Rep TopicRuleDestination = D1 ('MetaData "TopicRuleDestination" "Amazonka.IoT.Types.TopicRuleDestination" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "TopicRuleDestination'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpUrlProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpUrlDestinationProperties)))) :*: ((S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TopicRuleDestinationStatus))) :*: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcDestinationProperties))))))

newTopicRuleDestination :: TopicRuleDestination

Create a value of TopicRuleDestination with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:TopicRuleDestination', topicRuleDestination_arn - The topic rule destination URL.

$sel:createdAt:TopicRuleDestination', topicRuleDestination_createdAt - The date and time when the topic rule destination was created.

$sel:httpUrlProperties:TopicRuleDestination', topicRuleDestination_httpUrlProperties - Properties of the HTTP URL.

$sel:lastUpdatedAt:TopicRuleDestination', topicRuleDestination_lastUpdatedAt - The date and time when the topic rule destination was last updated.

$sel:status:TopicRuleDestination', topicRuleDestination_status - 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.

$sel:statusReason:TopicRuleDestination', topicRuleDestination_statusReason - Additional details or reason why the topic rule destination is in the current status.

$sel:vpcProperties:TopicRuleDestination', topicRuleDestination_vpcProperties - Properties of the virtual private cloud (VPC) connection.

topicRuleDestination_arn :: Lens' TopicRuleDestination (Maybe Text)

The topic rule destination URL.

topicRuleDestination_createdAt :: Lens' TopicRuleDestination (Maybe UTCTime)

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

topicRuleDestination_httpUrlProperties :: Lens' TopicRuleDestination (Maybe HttpUrlDestinationProperties)

Properties of the HTTP URL.

topicRuleDestination_lastUpdatedAt :: Lens' TopicRuleDestination (Maybe UTCTime)

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

topicRuleDestination_status :: Lens' TopicRuleDestination (Maybe TopicRuleDestinationStatus)

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.

topicRuleDestination_statusReason :: Lens' TopicRuleDestination (Maybe Text)

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

topicRuleDestination_vpcProperties :: Lens' TopicRuleDestination (Maybe VpcDestinationProperties)

Properties of the virtual private cloud (VPC) connection.