| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoT::TopicRuleDestination; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 6 | has HttpUrlProperties => (is => 'ro', isa => 'Paws::IoT::HttpUrlDestinationProperties', request_name => 'httpUrlProperties', traits => ['NameInRequest']); | ||
| 7 | has LastUpdatedAt => (is => 'ro', isa => 'Str', request_name => 'lastUpdatedAt', traits => ['NameInRequest']); | ||
| 8 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 9 | has StatusReason => (is => 'ro', isa => 'Str', request_name => 'statusReason', traits => ['NameInRequest']); | ||
| 10 | has VpcProperties => (is => 'ro', isa => 'Paws::IoT::VpcDestinationProperties', request_name => 'vpcProperties', traits => ['NameInRequest']); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::IoT::TopicRuleDestination | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::IoT::TopicRuleDestination object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { Arn => $value, ..., VpcProperties => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::TopicRuleDestination object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->Arn | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | A topic rule destination. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 Arn => Str | ||
| 48 | |||
| 49 | The topic rule destination URL. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 CreatedAt => Str | ||
| 53 | |||
| 54 | The date and time when the topic rule destination was created. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 HttpUrlProperties => L<Paws::IoT::HttpUrlDestinationProperties> | ||
| 58 | |||
| 59 | Properties of the HTTP URL. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 LastUpdatedAt => Str | ||
| 63 | |||
| 64 | The date and time when the topic rule destination was last updated. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Status => Str | ||
| 68 | |||
| 69 | The status of the topic rule destination. Valid values are: | ||
| 70 | |||
| 71 | =over | ||
| 72 | |||
| 73 | =item IN_PROGRESS | ||
| 74 | |||
| 75 | A topic rule destination was created but has not been confirmed. You | ||
| 76 | can set C<status> to C<IN_PROGRESS> by calling | ||
| 77 | C<UpdateTopicRuleDestination>. Calling C<UpdateTopicRuleDestination> | ||
| 78 | causes a new confirmation challenge to be sent to your confirmation | ||
| 79 | endpoint. | ||
| 80 | |||
| 81 | =item ENABLED | ||
| 82 | |||
| 83 | Confirmation was completed, and traffic to this destination is allowed. | ||
| 84 | You can set C<status> to C<DISABLED> by calling | ||
| 85 | C<UpdateTopicRuleDestination>. | ||
| 86 | |||
| 87 | =item DISABLED | ||
| 88 | |||
| 89 | Confirmation was completed, and traffic to this destination is not | ||
| 90 | allowed. You can set C<status> to C<ENABLED> by calling | ||
| 91 | C<UpdateTopicRuleDestination>. | ||
| 92 | |||
| 93 | =item ERROR | ||
| 94 | |||
| 95 | Confirmation could not be completed, for example if the confirmation | ||
| 96 | timed out. You can call C<GetTopicRuleDestination> for details about | ||
| 97 | the error. You can set C<status> to C<IN_PROGRESS> by calling | ||
| 98 | C<UpdateTopicRuleDestination>. Calling C<UpdateTopicRuleDestination> | ||
| 99 | causes a new confirmation challenge to be sent to your confirmation | ||
| 100 | endpoint. | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 StatusReason => Str | ||
| 107 | |||
| 108 | Additional details or reason why the topic rule destination is in the | ||
| 109 | current status. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 VpcProperties => L<Paws::IoT::VpcDestinationProperties> | ||
| 113 | |||
| 114 | Properties of the virtual private cloud (VPC) connection. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::IoT> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |