blib/lib/Paws/IoTSecureTunneling/OpenTunnel.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::IoTSecureTunneling::OpenTunnel;
3 use Moose;
4 has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' );
5 has DestinationConfig => (is => 'ro', isa => 'Paws::IoTSecureTunneling::DestinationConfig', traits => ['NameInRequest'], request_name => 'destinationConfig' );
6 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoTSecureTunneling::Tag]', traits => ['NameInRequest'], request_name => 'tags' );
7 has TimeoutConfig => (is => 'ro', isa => 'Paws::IoTSecureTunneling::TimeoutConfig', traits => ['NameInRequest'], request_name => 'timeoutConfig' );
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'OpenTunnel');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSecureTunneling::OpenTunnelResponse');
13 class_has _result_key => (isa => 'Str', is => 'ro');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::IoTSecureTunneling::OpenTunnel - Arguments for method OpenTunnel on L<Paws::IoTSecureTunneling>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method OpenTunnel on the
25 L<AWS IoT Secure Tunneling|Paws::IoTSecureTunneling> service. Use the attributes of this class
26 as arguments to method OpenTunnel.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to OpenTunnel.
29  
30 =head1 SYNOPSIS
31  
32 my $api.tunneling.iot = Paws->service('IoTSecureTunneling');
33 my $OpenTunnelResponse = $api . tunneling . iot->OpenTunnel(
34 Description => 'MyDescription', # OPTIONAL
35 DestinationConfig => {
36 Services => [
37 'MyService', ... # min: 1, max: 128
38 ], # min: 1
39 ThingName => 'MyThingName', # min: 1, max: 128; OPTIONAL
40 }, # OPTIONAL
41 Tags => [
42 {
43 Key => 'MyTagKey', # min: 1, max: 128
44 Value => 'MyTagValue', # max: 256
45  
46 },
47 ...
48 ], # OPTIONAL
49 TimeoutConfig => {
50 MaxLifetimeTimeoutMinutes => 1, # min: 1, max: 720; OPTIONAL
51 }, # OPTIONAL
52 );
53  
54 # Results:
55 my $DestinationAccessToken = $OpenTunnelResponse->DestinationAccessToken;
56 my $SourceAccessToken = $OpenTunnelResponse->SourceAccessToken;
57 my $TunnelArn = $OpenTunnelResponse->TunnelArn;
58 my $TunnelId = $OpenTunnelResponse->TunnelId;
59  
60 # Returns a L<Paws::IoTSecureTunneling::OpenTunnelResponse> object.
61  
62 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
63 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.tunneling.iot/OpenTunnel>
64  
65 =head1 ATTRIBUTES
66  
67  
68 =head2 Description => Str
69  
70 A short text description of the tunnel.
71  
72  
73  
74 =head2 DestinationConfig => L<Paws::IoTSecureTunneling::DestinationConfig>
75  
76 The destination configuration for the OpenTunnel request.
77  
78  
79  
80 =head2 Tags => ArrayRef[L<Paws::IoTSecureTunneling::Tag>]
81  
82 A collection of tag metadata.
83  
84  
85  
86 =head2 TimeoutConfig => L<Paws::IoTSecureTunneling::TimeoutConfig>
87  
88 Timeout configuration for a tunnel.
89  
90  
91  
92  
93 =head1 SEE ALSO
94  
95 This class forms part of L<Paws>, documenting arguments for method OpenTunnel in L<Paws::IoTSecureTunneling>
96  
97 =head1 BUGS and CONTRIBUTIONS
98  
99 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
100  
101 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
102  
103 =cut
104