File Coverage

blib/lib/Paws/EFS/CreateFileSystem.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::EFS::CreateFileSystem;
3 1     1   338 use Moose;
  1     1   3  
  1         5  
  1         557  
  1         2  
  1         8  
4             has CreationToken => (is => 'ro', isa => 'Str', required => 1);
5             has Encrypted => (is => 'ro', isa => 'Bool');
6             has KmsKeyId => (is => 'ro', isa => 'Str');
7             has PerformanceMode => (is => 'ro', isa => 'Str');
8              
9 1     1   5500 use MooseX::ClassAttribute;
  1     1   2  
  1         6  
  1         6462  
  1         2  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFileSystem');
12             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2015-02-01/file-systems');
13             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EFS::FileSystemDescription');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::EFS::CreateFileSystem - Arguments for method CreateFileSystem on Paws::EFS
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method CreateFileSystem on the
27             Amazon Elastic File System service. Use the attributes of this class
28             as arguments to method CreateFileSystem.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFileSystem.
31              
32             As an example:
33              
34             $service_obj->CreateFileSystem(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> CreationToken => Str
42              
43             String of up to 64 ASCII characters. Amazon EFS uses this to ensure
44             idempotent creation.
45              
46              
47              
48             =head2 Encrypted => Bool
49              
50             A boolean value that, if true, creates an encrypted file system. When
51             creating an encrypted file system, you have the option of specifying a
52             CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management
53             Service (AWS KMS) customer master key (CMK). If you don't specify a
54             CMK, then the default CMK for Amazon EFS, C</aws/elasticfilesystem>, is
55             used to protect the encrypted file system.
56              
57              
58              
59             =head2 KmsKeyId => Str
60              
61             The id of the AWS KMS CMK that will be used to protect the encrypted
62             file system. This parameter is only required if you want to use a
63             non-default CMK. If this parameter is not specified, the default CMK
64             for Amazon EFS is used. This id can be in one of the following formats:
65              
66             =over
67              
68             =item *
69              
70             Key ID - A unique identifier of the key. For example,
71             C<1234abcd-12ab-34cd-56ef-1234567890ab>.
72              
73             =item *
74              
75             ARN - An Amazon Resource Name for the key. For example,
76             C<arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab>.
77              
78             =item *
79              
80             Key alias - A previously created display name for a key. For example,
81             C<alias/projectKey1>.
82              
83             =item *
84              
85             Key alias ARN - An Amazon Resource Name for a key alias. For example,
86             C<arn:aws:kms:us-west-2:444455556666:alias/projectKey1>.
87              
88             =back
89              
90             Note that if the KmsKeyId is specified, the
91             CreateFileSystemRequest$Encrypted parameter must be set to true.
92              
93              
94              
95             =head2 PerformanceMode => Str
96              
97             The C<PerformanceMode> of the file system. We recommend
98             C<generalPurpose> performance mode for most file systems. File systems
99             using the C<maxIO> performance mode can scale to higher levels of
100             aggregate throughput and operations per second with a tradeoff of
101             slightly higher latencies for most file operations. This can't be
102             changed after the file system has been created.
103              
104             Valid values are: C<"generalPurpose">, C<"maxIO">
105              
106              
107             =head1 SEE ALSO
108              
109             This class forms part of L<Paws>, documenting arguments for method CreateFileSystem in L<Paws::EFS>
110              
111             =head1 BUGS and CONTRIBUTIONS
112              
113             The source code is located here: https://github.com/pplu/aws-sdk-perl
114              
115             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
116              
117             =cut
118