Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.Types.TopicRuleDestination

Description

Synopsis

data TopicRuleDestination = TopicRuleDestination' {
- vpcProperties :: Maybe VpcDestinationProperties
- status :: Maybe TopicRuleDestinationStatus
- lastUpdatedAt :: Maybe POSIX
- httpUrlProperties :: Maybe HttpUrlDestinationProperties
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- statusReason :: Maybe Text
}
newTopicRuleDestination :: TopicRuleDestination
topicRuleDestination_vpcProperties :: Lens' TopicRuleDestination (Maybe VpcDestinationProperties)
topicRuleDestination_status :: Lens' TopicRuleDestination (Maybe TopicRuleDestinationStatus)
topicRuleDestination_lastUpdatedAt :: Lens' TopicRuleDestination (Maybe UTCTime)
topicRuleDestination_httpUrlProperties :: Lens' TopicRuleDestination (Maybe HttpUrlDestinationProperties)
topicRuleDestination_arn :: Lens' TopicRuleDestination (Maybe Text)
topicRuleDestination_createdAt :: Lens' TopicRuleDestination (Maybe UTCTime)
topicRuleDestination_statusReason :: Lens' TopicRuleDestination (Maybe Text)

Documentation

data TopicRuleDestination Source #

A topic rule destination.

See: newTopicRuleDestination smart constructor.

Constructors

TopicRuleDestination'

Fields

vpcProperties :: Maybe VpcDestinationProperties
Properties of the virtual private cloud (VPC) connection.
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.
lastUpdatedAt :: Maybe POSIX
The date and time when the topic rule destination was last updated.
httpUrlProperties :: Maybe HttpUrlDestinationProperties
Properties of the HTTP URL.
arn :: Maybe Text
The topic rule destination URL.
createdAt :: Maybe POSIX
The date and time when the topic rule destination was created.
statusReason :: Maybe Text
Additional details or reason why the topic rule destination is in the current status.

Instances

Instances details

Eq TopicRuleDestination Source #
Instance details Defined in Amazonka.IoT.Types.TopicRuleDestination Methods (==) :: TopicRuleDestination -> TopicRuleDestination -> Bool # (/=) :: TopicRuleDestination -> TopicRuleDestination -> Bool #
Read TopicRuleDestination Source #
Instance details Defined in Amazonka.IoT.Types.TopicRuleDestination Methods readsPrec :: Int -> ReadS TopicRuleDestination # readList :: ReadS [TopicRuleDestination] # readPrec :: ReadPrec TopicRuleDestination # readListPrec :: ReadPrec [TopicRuleDestination] #
Show TopicRuleDestination Source #
Instance details Defined in Amazonka.IoT.Types.TopicRuleDestination Methods showsPrec :: Int -> TopicRuleDestination -> ShowS # show :: TopicRuleDestination -> String # showList :: [TopicRuleDestination] -> ShowS #
Generic TopicRuleDestination Source #
Instance details Defined in Amazonka.IoT.Types.TopicRuleDestination Associated Types type Rep TopicRuleDestination :: Type -> Type # Methods from :: TopicRuleDestination -> Rep TopicRuleDestination x # to :: Rep TopicRuleDestination x -> TopicRuleDestination #
NFData TopicRuleDestination Source #
Instance details Defined in Amazonka.IoT.Types.TopicRuleDestination Methods rnf :: TopicRuleDestination -> () #
Hashable TopicRuleDestination Source #
Instance details Defined in Amazonka.IoT.Types.TopicRuleDestination Methods hashWithSalt :: Int -> TopicRuleDestination -> Int # hash :: TopicRuleDestination -> Int #
FromJSON TopicRuleDestination Source #
Instance details Defined in Amazonka.IoT.Types.TopicRuleDestination Methods parseJSON :: Value -> Parser TopicRuleDestination # parseJSONList :: Value -> Parser [TopicRuleDestination] #
type Rep TopicRuleDestination Source #
Instance details Defined in Amazonka.IoT.Types.TopicRuleDestination type Rep TopicRuleDestination = D1 ('MetaData "TopicRuleDestination" "Amazonka.IoT.Types.TopicRuleDestination" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "TopicRuleDestination'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "vpcProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcDestinationProperties)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TopicRuleDestinationStatus)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "httpUrlProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpUrlDestinationProperties)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newTopicRuleDestination :: TopicRuleDestination Source #

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:vpcProperties:TopicRuleDestination', topicRuleDestination_vpcProperties - Properties of the virtual private cloud (VPC) connection.

$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:lastUpdatedAt:TopicRuleDestination', topicRuleDestination_lastUpdatedAt - The date and time when the topic rule destination was last updated.

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

$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:statusReason:TopicRuleDestination', topicRuleDestination_statusReason - Additional details or reason why the topic rule destination is in the current status.

topicRuleDestination_vpcProperties :: Lens' TopicRuleDestination (Maybe VpcDestinationProperties) Source #

Properties of the virtual private cloud (VPC) connection.

topicRuleDestination_status :: Lens' TopicRuleDestination (Maybe TopicRuleDestinationStatus) Source #

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_lastUpdatedAt :: Lens' TopicRuleDestination (Maybe UTCTime) Source #

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

topicRuleDestination_httpUrlProperties :: Lens' TopicRuleDestination (Maybe HttpUrlDestinationProperties) Source #

Properties of the HTTP URL.

topicRuleDestination_arn :: Lens' TopicRuleDestination (Maybe Text) Source #

The topic rule destination URL.

topicRuleDestination_createdAt :: Lens' TopicRuleDestination (Maybe UTCTime) Source #

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

topicRuleDestination_statusReason :: Lens' TopicRuleDestination (Maybe Text) Source #

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