« blib/lib/Paws/IoTSecureTunneling/TimeoutConfig.pm
↑ Summary
blib/lib/Paws/IoTSecureTunneling/TunnelSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTSecureTunneling::Tunnel; | ||
| 3 | use Moose; | ||
| 4 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 6 | has DestinationConfig => (is => 'ro', isa => 'Paws::IoTSecureTunneling::DestinationConfig', request_name => 'destinationConfig', traits => ['NameInRequest']); | ||
| 7 | has DestinationConnectionState => (is => 'ro', isa => 'Paws::IoTSecureTunneling::ConnectionState', request_name => 'destinationConnectionState', traits => ['NameInRequest']); | ||
| 8 | has LastUpdatedAt => (is => 'ro', isa => 'Str', request_name => 'lastUpdatedAt', traits => ['NameInRequest']); | ||
| 9 | has SourceConnectionState => (is => 'ro', isa => 'Paws::IoTSecureTunneling::ConnectionState', request_name => 'sourceConnectionState', traits => ['NameInRequest']); | ||
| 10 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoTSecureTunneling::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 12 | has TimeoutConfig => (is => 'ro', isa => 'Paws::IoTSecureTunneling::TimeoutConfig', request_name => 'timeoutConfig', traits => ['NameInRequest']); | ||
| 13 | has TunnelArn => (is => 'ro', isa => 'Str', request_name => 'tunnelArn', traits => ['NameInRequest']); | ||
| 14 | has TunnelId => (is => 'ro', isa => 'Str', request_name => 'tunnelId', traits => ['NameInRequest']); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IoTSecureTunneling::Tunnel | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::IoTSecureTunneling::Tunnel object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { CreatedAt => $value, ..., TunnelId => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTSecureTunneling::Tunnel object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->CreatedAt | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | A connection between a source computer and a destination device. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 CreatedAt => Str | ||
| 52 | |||
| 53 | The time when the tunnel was created. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Description => Str | ||
| 57 | |||
| 58 | A description of the tunnel. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 DestinationConfig => L<Paws::IoTSecureTunneling::DestinationConfig> | ||
| 62 | |||
| 63 | The destination configuration that specifies the thing name of the | ||
| 64 | destination device and a service name that the local proxy uses to | ||
| 65 | connect to the destination application. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 DestinationConnectionState => L<Paws::IoTSecureTunneling::ConnectionState> | ||
| 69 | |||
| 70 | The connection state of the destination application. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 LastUpdatedAt => Str | ||
| 74 | |||
| 75 | The last time the tunnel was updated. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 SourceConnectionState => L<Paws::IoTSecureTunneling::ConnectionState> | ||
| 79 | |||
| 80 | The connection state of the source application. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Status => Str | ||
| 84 | |||
| 85 | The status of a tunnel. Valid values are: Open and Closed. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 Tags => ArrayRef[L<Paws::IoTSecureTunneling::Tag>] | ||
| 89 | |||
| 90 | A list of tag metadata associated with the secure tunnel. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 TimeoutConfig => L<Paws::IoTSecureTunneling::TimeoutConfig> | ||
| 94 | |||
| 95 | Timeout configuration for the tunnel. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 TunnelArn => Str | ||
| 99 | |||
| 100 | The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is | ||
| 101 | C<arn:aws:tunnel:E<lt>regionE<gt>:E<lt>account-idE<gt>:tunnel/E<lt>tunnel-idE<gt>> | ||
| 102 | |||
| 103 | |||
| 104 | =head2 TunnelId => Str | ||
| 105 | |||
| 106 | A unique alpha-numeric ID that identifies a tunnel. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTSecureTunneling> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |