blib/lib/Paws/StorageGateway/UpdateChapCredentials.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::StorageGateway::UpdateChapCredentials;
3 use Moose;
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 use MooseX::ClassAttribute;
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 L<Paws::StorageGateway>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method UpdateChapCredentials on the
25 L<AWS Storage Gateway|Paws::StorageGateway> 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 =head1 SYNOPSIS
31  
32 my $storagegateway = Paws->service('StorageGateway');
33 # To update CHAP credentials for an iSCSI target
34 # Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for
35 # a specified iSCSI target.
36 my $UpdateChapCredentialsOutput = $storagegateway->UpdateChapCredentials(
37 'InitiatorName' =>
38 'iqn.1991-05.com.microsoft:computername.domain.example.com',
39 'SecretToAuthenticateInitiator' => 111111111111,
40 'SecretToAuthenticateTarget' => 222222222222,
41 'TargetARN' =>
42 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume'
43 );
44  
45 # Results:
46 my $InitiatorName = $UpdateChapCredentialsOutput->InitiatorName;
47 my $TargetARN = $UpdateChapCredentialsOutput->TargetARN;
48  
49 # Returns a L<Paws::StorageGateway::UpdateChapCredentialsOutput> object.
50  
51 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.
52 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/storagegateway/UpdateChapCredentials>
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 B<REQUIRED> InitiatorName => Str
58  
59 The iSCSI initiator that connects to the target.
60  
61  
62  
63 =head2 B<REQUIRED> SecretToAuthenticateInitiator => Str
64  
65 The secret key that the initiator (for example, the Windows client)
66 must provide to participate in mutual CHAP with the target.
67  
68 The secret key must be between 12 and 16 bytes when encoded in UTF-8.
69  
70  
71  
72 =head2 SecretToAuthenticateTarget => Str
73  
74 The secret key that the target must provide to participate in mutual
75 CHAP with the initiator (e.g. Windows client).
76  
77 Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
78  
79 The secret key must be between 12 and 16 bytes when encoded in UTF-8.
80  
81  
82  
83 =head2 B<REQUIRED> TargetARN => Str
84  
85 The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
86 DescribeStorediSCSIVolumes operation to return the TargetARN for
87 specified VolumeARN.
88  
89  
90  
91  
92 =head1 SEE ALSO
93  
94 This class forms part of L<Paws>, documenting arguments for method UpdateChapCredentials in L<Paws::StorageGateway>
95  
96 =head1 BUGS and CONTRIBUTIONS
97  
98 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
99  
100 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
101  
102 =cut
103