File Coverage

blib/lib/Paws/StorageGateway/ChapInfo.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::StorageGateway::ChapInfo;
2 1     1   268 use Moose;
  1         2  
  1         6  
3             has InitiatorName => (is => 'ro', isa => 'Str');
4             has SecretToAuthenticateInitiator => (is => 'ro', isa => 'Str');
5             has SecretToAuthenticateTarget => (is => 'ro', isa => 'Str');
6             has TargetARN => (is => 'ro', isa => 'Str');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::StorageGateway::ChapInfo
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::StorageGateway::ChapInfo object:
25              
26             $service_obj->Method(Att1 => { InitiatorName => $value, ..., TargetARN => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::StorageGateway::ChapInfo object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->InitiatorName
34              
35             =head1 DESCRIPTION
36              
37             Describes Challenge-Handshake Authentication Protocol (CHAP)
38             information that supports authentication between your gateway and iSCSI
39             initiators.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 InitiatorName => Str
45              
46             The iSCSI initiator that connects to the target.
47              
48              
49             =head2 SecretToAuthenticateInitiator => Str
50              
51             The secret key that the initiator (for example, the Windows client)
52             must provide to participate in mutual CHAP with the target.
53              
54              
55             =head2 SecretToAuthenticateTarget => Str
56              
57             The secret key that the target must provide to participate in mutual
58             CHAP with the initiator (e.g. Windows client).
59              
60              
61             =head2 TargetARN => Str
62              
63             The Amazon Resource Name (ARN) of the volume.
64              
65             Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and
66             hyphens (-).
67              
68              
69              
70             =head1 SEE ALSO
71              
72             This class forms part of L<Paws>, describing an object used in L<Paws::StorageGateway>
73              
74             =head1 BUGS and CONTRIBUTIONS
75              
76             The source code is located here: https://github.com/pplu/aws-sdk-perl
77              
78             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
79              
80             =cut
81