Amazonka.IoT.Types.TopicRuleDestinationSummary

Documentation

data TopicRuleDestinationSummary

Information about the topic rule destination.

See: newTopicRuleDestinationSummary smart constructor.

Constructors

TopicRuleDestinationSummary'

Fields

• arn :: Maybe Text

  The topic rule destination ARN.

• createdAt :: Maybe POSIX

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

• httpUrlSummary :: Maybe HttpUrlDestinationSummary

  Information about 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

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

• vpcDestinationSummary :: Maybe VpcDestinationSummary

  Information about the virtual private cloud (VPC) connection.

Instances

FromJSON TopicRuleDestinationSummary

Defined in Amazonka.IoT.Types.TopicRuleDestinationSummary

Methods

parseJSON :: Value -> Parser TopicRuleDestinationSummary

parseJSONList :: Value -> Parser [TopicRuleDestinationSummary]

Generic TopicRuleDestinationSummary

Defined in Amazonka.IoT.Types.TopicRuleDestinationSummary

Associated Types

type Rep TopicRuleDestinationSummary :: Type -> Type

Methods

from :: TopicRuleDestinationSummary -> Rep TopicRuleDestinationSummary x

to :: Rep TopicRuleDestinationSummary x -> TopicRuleDestinationSummary

Read TopicRuleDestinationSummary

Defined in Amazonka.IoT.Types.TopicRuleDestinationSummary

Methods

readsPrec :: Int -> ReadS TopicRuleDestinationSummary

readList :: ReadS [TopicRuleDestinationSummary]

readPrec :: ReadPrec TopicRuleDestinationSummary

readListPrec :: ReadPrec [TopicRuleDestinationSummary]

Show TopicRuleDestinationSummary

Defined in Amazonka.IoT.Types.TopicRuleDestinationSummary

Methods

showsPrec :: Int -> TopicRuleDestinationSummary -> ShowS

show :: TopicRuleDestinationSummary -> String

showList :: [TopicRuleDestinationSummary] -> ShowS

NFData TopicRuleDestinationSummary

Defined in Amazonka.IoT.Types.TopicRuleDestinationSummary

Methods

rnf :: TopicRuleDestinationSummary -> ()

Eq TopicRuleDestinationSummary

Defined in Amazonka.IoT.Types.TopicRuleDestinationSummary

Methods

(==) :: TopicRuleDestinationSummary -> TopicRuleDestinationSummary -> Bool

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

Hashable TopicRuleDestinationSummary

Defined in Amazonka.IoT.Types.TopicRuleDestinationSummary

Methods

hashWithSalt :: Int -> TopicRuleDestinationSummary -> Int

hash :: TopicRuleDestinationSummary -> Int

type Rep TopicRuleDestinationSummary

Defined in Amazonka.IoT.Types.TopicRuleDestinationSummary

type Rep TopicRuleDestinationSummary = D1 ('MetaData "TopicRuleDestinationSummary" "Amazonka.IoT.Types.TopicRuleDestinationSummary" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "TopicRuleDestinationSummary'" '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 "httpUrlSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpUrlDestinationSummary)))) :*: ((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 "vpcDestinationSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcDestinationSummary))))))

newTopicRuleDestinationSummary :: TopicRuleDestinationSummary

Create a value of TopicRuleDestinationSummary 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:TopicRuleDestinationSummary', topicRuleDestinationSummary_arn - The topic rule destination ARN.

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

$sel:httpUrlSummary:TopicRuleDestinationSummary', topicRuleDestinationSummary_httpUrlSummary - Information about the HTTP URL.

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

$sel:status:TopicRuleDestinationSummary', topicRuleDestinationSummary_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:TopicRuleDestinationSummary', topicRuleDestinationSummary_statusReason - The reason the topic rule destination is in the current status.

$sel:vpcDestinationSummary:TopicRuleDestinationSummary', topicRuleDestinationSummary_vpcDestinationSummary - Information about the virtual private cloud (VPC) connection.

topicRuleDestinationSummary_arn :: Lens' TopicRuleDestinationSummary (Maybe Text)

The topic rule destination ARN.

topicRuleDestinationSummary_createdAt :: Lens' TopicRuleDestinationSummary (Maybe UTCTime)

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

topicRuleDestinationSummary_httpUrlSummary :: Lens' TopicRuleDestinationSummary (Maybe HttpUrlDestinationSummary)

Information about the HTTP URL.

topicRuleDestinationSummary_lastUpdatedAt :: Lens' TopicRuleDestinationSummary (Maybe UTCTime)

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

topicRuleDestinationSummary_status :: Lens' TopicRuleDestinationSummary (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.

topicRuleDestinationSummary_statusReason :: Lens' TopicRuleDestinationSummary (Maybe Text)

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

topicRuleDestinationSummary_vpcDestinationSummary :: Lens' TopicRuleDestinationSummary (Maybe VpcDestinationSummary)

Information about the virtual private cloud (VPC) connection.