File Coverage

blib/lib/Paws/StorageGateway/UpdateChapCredentials.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::StorageGateway::UpdateChapCredentials;
3 1     1   318 use Moose;
  1         2  
  1         9  
4             has InitiatorName => (is => 'ro', isa => 'Str', required => 1);
5             has SecretToAuthenticateInitiator => (is => 'ro', isa => 'Str', required => 1);
6             has SecretToAuthenticateTarget => (is => 'ro', isa => 'Str');
7             has TargetARN => (is => 'ro', isa => 'Str', required => 1);
8              
9 1     1   5548 use MooseX::ClassAttribute;
  1         3  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateChapCredentials');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StorageGateway::UpdateChapCredentialsOutput');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::StorageGateway::UpdateChapCredentials - Arguments for method UpdateChapCredentials on Paws::StorageGateway
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method UpdateChapCredentials on the
25             AWS Storage Gateway service. Use the attributes of this class
26             as arguments to method UpdateChapCredentials.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateChapCredentials.
29              
30             As an example:
31              
32             $service_obj->UpdateChapCredentials(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> InitiatorName => Str
40              
41             The iSCSI initiator that connects to the target.
42              
43              
44              
45             =head2 B<REQUIRED> SecretToAuthenticateInitiator => Str
46              
47             The secret key that the initiator (for example, the Windows client)
48             must provide to participate in mutual CHAP with the target.
49              
50             The secret key must be between 12 and 16 bytes when encoded in UTF-8.
51              
52              
53              
54             =head2 SecretToAuthenticateTarget => Str
55              
56             The secret key that the target must provide to participate in mutual
57             CHAP with the initiator (e.g. Windows client).
58              
59             Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
60              
61             The secret key must be between 12 and 16 bytes when encoded in UTF-8.
62              
63              
64              
65             =head2 B<REQUIRED> TargetARN => Str
66              
67             The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
68             DescribeStorediSCSIVolumes operation to return the TargetARN for
69             specified VolumeARN.
70              
71              
72              
73              
74             =head1 SEE ALSO
75              
76             This class forms part of L<Paws>, documenting arguments for method UpdateChapCredentials in L<Paws::StorageGateway>
77              
78             =head1 BUGS and CONTRIBUTIONS
79              
80             The source code is located here: https://github.com/pplu/aws-sdk-perl
81              
82             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
83              
84             =cut
85