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

filter: Statementstmt 0.0% 0 / 23 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 25 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::StorageGateway::UpdateNFSFileShare;
3 use Moose;
4 has CacheAttributes => (is => 'ro', isa => 'Paws::StorageGateway::CacheAttributes');
5 has ClientList => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6 has DefaultStorageClass => (is => 'ro', isa => 'Str');
7 has FileShareARN => (is => 'ro', isa => 'Str', required => 1);
8 has FileShareName => (is => 'ro', isa => 'Str');
9 has GuessMIMETypeEnabled => (is => 'ro', isa => 'Bool');
10 has KMSEncrypted => (is => 'ro', isa => 'Bool');
11 has KMSKey => (is => 'ro', isa => 'Str');
12 has NFSFileShareDefaults => (is => 'ro', isa => 'Paws::StorageGateway::NFSFileShareDefaults');
13 has NotificationPolicy => (is => 'ro', isa => 'Str');
14 has ObjectACL => (is => 'ro', isa => 'Str');
15 has ReadOnly => (is => 'ro', isa => 'Bool');
16 has RequesterPays => (is => 'ro', isa => 'Bool');
17 has Squash => (is => 'ro', isa => 'Str');
18  
19 use MooseX::ClassAttribute;
20  
21 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateNFSFileShare');
22 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StorageGateway::UpdateNFSFileShareOutput');
23 class_has _result_key => (isa => 'Str', is => 'ro');
24 1;
25  
26 ### main pod documentation begin ###
27  
28 =head1 NAME
29  
30 Paws::StorageGateway::UpdateNFSFileShare - Arguments for method UpdateNFSFileShare on L<Paws::StorageGateway>
31  
32 =head1 DESCRIPTION
33  
34 This class represents the parameters used for calling the method UpdateNFSFileShare on the
35 L<AWS Storage Gateway|Paws::StorageGateway> service. Use the attributes of this class
36 as arguments to method UpdateNFSFileShare.
37  
38 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateNFSFileShare.
39  
40 =head1 SYNOPSIS
41  
42 my $storagegateway = Paws->service('StorageGateway');
43 my $UpdateNFSFileShareOutput = $storagegateway->UpdateNFSFileShare(
44 FileShareARN => 'MyFileShareARN',
45 CacheAttributes => {
46 CacheStaleTimeoutInSeconds => 1, # OPTIONAL
47 }, # OPTIONAL
48 ClientList => [ 'MyIPV4AddressCIDR', ... ], # OPTIONAL
49 DefaultStorageClass => 'MyStorageClass', # OPTIONAL
50 FileShareName => 'MyFileShareName', # OPTIONAL
51 GuessMIMETypeEnabled => 1, # OPTIONAL
52 KMSEncrypted => 1, # OPTIONAL
53 KMSKey => 'MyKMSKey', # OPTIONAL
54 NFSFileShareDefaults => {
55 DirectoryMode => 'MyPermissionMode', # min: 1, max: 4; OPTIONAL
56 FileMode => 'MyPermissionMode', # min: 1, max: 4; OPTIONAL
57 GroupId => 1, # max: 4294967294; OPTIONAL
58 OwnerId => 1, # max: 4294967294; OPTIONAL
59 }, # OPTIONAL
60 NotificationPolicy => 'MyNotificationPolicy', # OPTIONAL
61 ObjectACL => 'private', # OPTIONAL
62 ReadOnly => 1, # OPTIONAL
63 RequesterPays => 1, # OPTIONAL
64 Squash => 'MySquash', # OPTIONAL
65 );
66  
67 # Results:
68 my $FileShareARN = $UpdateNFSFileShareOutput->FileShareARN;
69  
70 # Returns a L<Paws::StorageGateway::UpdateNFSFileShareOutput> object.
71  
72 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.
73 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/storagegateway/UpdateNFSFileShare>
74  
75 =head1 ATTRIBUTES
76  
77  
78 =head2 CacheAttributes => L<Paws::StorageGateway::CacheAttributes>
79  
80 specifies refresh cache information for the file share.
81  
82  
83  
84 =head2 ClientList => ArrayRef[Str|Undef]
85  
86 The list of clients that are allowed to access the file gateway. The
87 list must contain either valid IP addresses or valid CIDR blocks.
88  
89  
90  
91 =head2 DefaultStorageClass => Str
92  
93 The default storage class for objects put into an Amazon S3 bucket by
94 the file gateway. The default value is C<S3_INTELLIGENT_TIERING>.
95 Optional.
96  
97 Valid Values: C<S3_STANDARD> | C<S3_INTELLIGENT_TIERING> |
98 C<S3_STANDARD_IA> | C<S3_ONEZONE_IA>
99  
100  
101  
102 =head2 B<REQUIRED> FileShareARN => Str
103  
104 The Amazon Resource Name (ARN) of the file share to be updated.
105  
106  
107  
108 =head2 FileShareName => Str
109  
110 The name of the file share. Optional.
111  
112 C<FileShareName> must be set if an S3 prefix name is set in
113 C<LocationARN>.
114  
115  
116  
117 =head2 GuessMIMETypeEnabled => Bool
118  
119 A value that enables guessing of the MIME type for uploaded objects
120 based on file extensions. Set this value to C<true> to enable MIME type
121 guessing, otherwise set to C<false>. The default value is C<true>.
122  
123 Valid Values: C<true> | C<false>
124  
125  
126  
127 =head2 KMSEncrypted => Bool
128  
129 Set to C<true> to use Amazon S3 server-side encryption with your own
130 AWS KMS key, or C<false> to use a key managed by Amazon S3. Optional.
131  
132 Valid Values: C<true> | C<false>
133  
134  
135  
136 =head2 KMSKey => Str
137  
138 The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
139 used for Amazon S3 server-side encryption. Storage Gateway does not
140 support asymmetric CMKs. This value can only be set when
141 C<KMSEncrypted> is C<true>. Optional.
142  
143  
144  
145 =head2 NFSFileShareDefaults => L<Paws::StorageGateway::NFSFileShareDefaults>
146  
147 The default values for the file share. Optional.
148  
149  
150  
151 =head2 NotificationPolicy => Str
152  
153 The notification policy of the file share. C<SettlingTimeInSeconds>
154 controls the number of seconds to wait after the last point in time a
155 client wrote to a file before generating an C<ObjectUploaded>
156 notification. Because clients can make many small writes to files, it's
157 best to set this parameter for as long as possible to avoid generating
158 multiple notifications for the same file in a small time period.
159  
160 C<SettlingTimeInSeconds> has no effect on the timing of the object
161 uploading to Amazon S3, only the timing of the notification.
162  
163 The following example sets C<NotificationPolicy> on with
164 C<SettlingTimeInSeconds> set to 60.
165  
166 C<{\"Upload\": {\"SettlingTimeInSeconds\": 60}}>
167  
168 The following example sets C<NotificationPolicy> off.
169  
170 C<{}>
171  
172  
173  
174 =head2 ObjectACL => Str
175  
176 A value that sets the access control list (ACL) permission for objects
177 in the S3 bucket that a file gateway puts objects into. The default
178 value is C<private>.
179  
180 Valid values are: C<"private">, C<"public-read">, C<"public-read-write">, C<"authenticated-read">, C<"bucket-owner-read">, C<"bucket-owner-full-control">, C<"aws-exec-read">
181  
182 =head2 ReadOnly => Bool
183  
184 A value that sets the write status of a file share. Set this value to
185 C<true> to set the write status to read-only, otherwise set to
186 C<false>.
187  
188 Valid Values: C<true> | C<false>
189  
190  
191  
192 =head2 RequesterPays => Bool
193  
194 A value that sets who pays the cost of the request and the cost
195 associated with data download from the S3 bucket. If this value is set
196 to C<true>, the requester pays the costs; otherwise, the S3 bucket
197 owner pays. However, the S3 bucket owner always pays the cost of
198 storing data.
199  
200 C<RequesterPays> is a configuration for the S3 bucket that backs the
201 file share, so make sure that the configuration on the file share is
202 the same as the S3 bucket configuration.
203  
204 Valid Values: C<true> | C<false>
205  
206  
207  
208 =head2 Squash => Str
209  
210 The user mapped to anonymous user.
211  
212 Valid values are the following:
213  
214 =over
215  
216 =item *
217  
218 C<RootSquash>: Only root is mapped to anonymous user.
219  
220 =item *
221  
222 C<NoSquash>: No one is mapped to anonymous user.
223  
224 =item *
225  
226 C<AllSquash>: Everyone is mapped to anonymous user.
227  
228 =back
229  
230  
231  
232  
233  
234 =head1 SEE ALSO
235  
236 This class forms part of L<Paws>, documenting arguments for method UpdateNFSFileShare in L<Paws::StorageGateway>
237  
238 =head1 BUGS and CONTRIBUTIONS
239  
240 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
241  
242 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
243  
244 =cut
245