File Coverage

blib/lib/Paws/StorageGateway/CreateNFSFileShare.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::CreateNFSFileShare;
3 1     1   319 use Moose;
  1         2  
  1         7  
4             has ClientList => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has ClientToken => (is => 'ro', isa => 'Str', required => 1);
6             has DefaultStorageClass => (is => 'ro', isa => 'Str');
7             has GatewayARN => (is => 'ro', isa => 'Str', required => 1);
8             has KMSEncrypted => (is => 'ro', isa => 'Bool');
9             has KMSKey => (is => 'ro', isa => 'Str');
10             has LocationARN => (is => 'ro', isa => 'Str', required => 1);
11             has NFSFileShareDefaults => (is => 'ro', isa => 'Paws::StorageGateway::NFSFileShareDefaults');
12             has ReadOnly => (is => 'ro', isa => 'Bool');
13             has Role => (is => 'ro', isa => 'Str', required => 1);
14             has Squash => (is => 'ro', isa => 'Str');
15              
16 1     1   5539 use MooseX::ClassAttribute;
  1         2  
  1         9  
17              
18             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateNFSFileShare');
19             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StorageGateway::CreateNFSFileShareOutput');
20             class_has _result_key => (isa => 'Str', is => 'ro');
21             1;
22              
23             ### main pod documentation begin ###
24              
25             =head1 NAME
26              
27             Paws::StorageGateway::CreateNFSFileShare - Arguments for method CreateNFSFileShare on Paws::StorageGateway
28              
29             =head1 DESCRIPTION
30              
31             This class represents the parameters used for calling the method CreateNFSFileShare on the
32             AWS Storage Gateway service. Use the attributes of this class
33             as arguments to method CreateNFSFileShare.
34              
35             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNFSFileShare.
36              
37             As an example:
38              
39             $service_obj->CreateNFSFileShare(Att1 => $value1, Att2 => $value2, ...);
40              
41             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.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 ClientList => ArrayRef[Str|Undef]
47              
48             The list of clients that are allowed to access the file gateway. The
49             list must contain either valid IP addresses or valid CIDR blocks.
50              
51              
52              
53             =head2 B<REQUIRED> ClientToken => Str
54              
55             A unique string value that you supply that is used by file gateway to
56             ensure idempotent file share creation.
57              
58              
59              
60             =head2 DefaultStorageClass => Str
61              
62             The default storage class for objects put into an Amazon S3 bucket by
63             file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If
64             this field is not populated, the default value S3_STANDARD is used.
65             Optional.
66              
67              
68              
69             =head2 B<REQUIRED> GatewayARN => Str
70              
71             The Amazon Resource Name (ARN) of the file gateway on which you want to
72             create a file share.
73              
74              
75              
76             =head2 KMSEncrypted => Bool
77              
78             True to use Amazon S3 server side encryption with your own AWS KMS key,
79             or false to use a key managed by Amazon S3. Optional.
80              
81              
82              
83             =head2 KMSKey => Str
84              
85             The KMS key used for Amazon S3 server side encryption. This value can
86             only be set when KmsEncrypted is true. Optional.
87              
88              
89              
90             =head2 B<REQUIRED> LocationARN => Str
91              
92             The ARN of the backed storage used for storing file data.
93              
94              
95              
96             =head2 NFSFileShareDefaults => L<Paws::StorageGateway::NFSFileShareDefaults>
97              
98             File share default values. Optional.
99              
100              
101              
102             =head2 ReadOnly => Bool
103              
104             Sets the write status of a file share: "true" if the write status is
105             read-only, and otherwise "false".
106              
107              
108              
109             =head2 B<REQUIRED> Role => Str
110              
111             The ARN of the AWS Identity and Access Management (IAM) role that a
112             file gateway assumes when it accesses the underlying storage.
113              
114              
115              
116             =head2 Squash => Str
117              
118             Maps a user to anonymous user. Valid options are the following:
119              
120             =over
121              
122             =item *
123              
124             "RootSquash" - Only root is mapped to anonymous user.
125              
126             =item *
127              
128             "NoSquash" - No one is mapped to anonymous user.
129              
130             =item *
131              
132             "AllSquash" - Everyone is mapped to anonymous user.
133              
134             =back
135              
136              
137              
138              
139              
140             =head1 SEE ALSO
141              
142             This class forms part of L<Paws>, documenting arguments for method CreateNFSFileShare in L<Paws::StorageGateway>
143              
144             =head1 BUGS and CONTRIBUTIONS
145              
146             The source code is located here: https://github.com/pplu/aws-sdk-perl
147              
148             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
149              
150             =cut
151