blib/lib/Paws/EFS/CreateFileSystem.pm

filter: Statementstmt 100% 20 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 22 / 22 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/VpnStaticRoute.pm ↑ Summary blib/lib/Paws/EFS/DeleteFileSystem.pm »
1  
2 package Paws::EFS::CreateFileSystem;
3 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 has AvailabilityZoneName => (is => 'ro', isa => 'Str');
5 2 has Backup => (is => 'ro', isa => 'Bool');
6 2 has CreationToken => (is => 'ro', isa => 'Str', required => 1);
7 2 has Encrypted => (is => 'ro', isa => 'Bool');
8 2 has KmsKeyId => (is => 'ro', isa => 'Str');
9 2 has PerformanceMode => (is => 'ro', isa => 'Str');
10 2 has ProvisionedThroughputInMibps => (is => 'ro', isa => 'Num');
11 2 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::EFS::Tag]');
12 2 has ThroughputMode => (is => 'ro', isa => 'Str');
13  
14 2 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
15  
16 2 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFileSystem');
17 2 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2015-02-01/file-systems');
18 2 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
19 2 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EFS::FileSystemDescription');
20 2 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::EFS::CreateFileSystem - Arguments for method CreateFileSystem on L<Paws::EFS>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method CreateFileSystem on the
31 L<Amazon Elastic File System|Paws::EFS> service. Use the attributes of this class
32 as arguments to method CreateFileSystem.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFileSystem.
35  
36 =head1 SYNOPSIS
37  
38 my $elasticfilesystem = Paws->service('EFS');
39 # To create a new file system
40 # This operation creates a new file system with the default generalpurpose
41 # performance mode.
42 my $FileSystemDescription = $elasticfilesystem->CreateFileSystem(
43 'CreationToken' => 'tokenstring',
44 'PerformanceMode' => 'generalPurpose',
45 'Tags' => [
46  
47 {
48 'Key' => 'Name',
49 'Value' => 'MyFileSystem'
50 }
51 ]
52 );
53  
54 # Results:
55 my $CreationTime = $FileSystemDescription->CreationTime;
56 my $CreationToken = $FileSystemDescription->CreationToken;
57 my $FileSystemId = $FileSystemDescription->FileSystemId;
58 my $LifeCycleState = $FileSystemDescription->LifeCycleState;
59 my $NumberOfMountTargets = $FileSystemDescription->NumberOfMountTargets;
60 my $OwnerId = $FileSystemDescription->OwnerId;
61 my $PerformanceMode = $FileSystemDescription->PerformanceMode;
62 my $SizeInBytes = $FileSystemDescription->SizeInBytes;
63 my $Tags = $FileSystemDescription->Tags;
64  
65 # Returns a L<Paws::EFS::FileSystemDescription> object.
66  
67 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.
68 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem/CreateFileSystem>
69  
70 =head1 ATTRIBUTES
71  
72  
73 =head2 AvailabilityZoneName => Str
74  
75 Used to create a file system that uses One Zone storage classes. It
76 specifies the AWS Availability Zone in which to create the file system.
77 Use the format C<us-east-1a> to specify the Availability Zone. For more
78 information about One Zone storage classes, see Using EFS storage
79 classes
80 (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the
81 I<Amazon EFS User Guide>.
82  
83 One Zone storage classes are not available in all Availability Zones in
84 AWS Regions where Amazon EFS is available.
85  
86  
87  
88 =head2 Backup => Bool
89  
90 Specifies whether automatic backups are enabled on the file system that
91 you are creating. Set the value to C<true> to enable automatic backups.
92 If you are creating a file system that uses One Zone storage classes,
93 automatic backups are enabled by default. For more information, see
94 Automatic backups
95 (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups)
96 in the I<Amazon EFS User Guide>.
97  
98 Default is C<false>. However, if you specify an
99 C<AvailabilityZoneName>, the default is C<true>.
100  
101 AWS Backup is not available in all AWS Regions where Amazon EFS is
102 available.
103  
104  
105  
106 =head2 B<REQUIRED> CreationToken => Str
107  
108 A string of up to 64 ASCII characters. Amazon EFS uses this to ensure
109 idempotent creation.
110  
111  
112  
113 =head2 Encrypted => Bool
114  
115 A Boolean value that, if true, creates an encrypted file system. When
116 creating an encrypted file system, you have the option of specifying
117 CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management
118 Service (AWS KMS) customer master key (CMK). If you don't specify a
119 CMK, then the default CMK for Amazon EFS, C</aws/elasticfilesystem>, is
120 used to protect the encrypted file system.
121  
122  
123  
124 =head2 KmsKeyId => Str
125  
126 The ID of the AWS KMS CMK that you want to use to protect the encrypted
127 file system. This parameter is only required if you want to use a
128 non-default KMS key. If this parameter is not specified, the default
129 CMK for Amazon EFS is used. This ID can be in one of the following
130 formats:
131  
132 =over
133  
134 =item *
135  
136 Key ID - A unique identifier of the key, for example
137 C<1234abcd-12ab-34cd-56ef-1234567890ab>.
138  
139 =item *
140  
141 ARN - An Amazon Resource Name (ARN) for the key, for example
142 C<arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab>.
143  
144 =item *
145  
146 Key alias - A previously created display name for a key, for example
147 C<alias/projectKey1>.
148  
149 =item *
150  
151 Key alias ARN - An ARN for a key alias, for example
152 C<arn:aws:kms:us-west-2:444455556666:alias/projectKey1>.
153  
154 =back
155  
156 If C<KmsKeyId> is specified, the CreateFileSystemRequest$Encrypted
157 parameter must be set to true.
158  
159 EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys
160 with EFS file systems.
161  
162  
163  
164 =head2 PerformanceMode => Str
165  
166 The performance mode of the file system. We recommend C<generalPurpose>
167 performance mode for most file systems. File systems using the C<maxIO>
168 performance mode can scale to higher levels of aggregate throughput and
169 operations per second with a tradeoff of slightly higher latencies for
170 most file operations. The performance mode can't be changed after the
171 file system has been created.
172  
173 The C<maxIO> mode is not supported on file systems using One Zone
174 storage classes.
175  
176 Valid values are: C<"generalPurpose">, C<"maxIO">
177  
178 =head2 ProvisionedThroughputInMibps => Num
179  
180 The throughput, measured in MiB/s, that you want to provision for a
181 file system that you're creating. Valid values are 1-1024. Required if
182 C<ThroughputMode> is set to C<provisioned>. The upper limit for
183 throughput is 1024 MiB/s. To increase this limit, contact AWS Support.
184 For more information, see Amazon EFS quotas that you can increase
185 (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in
186 the I<Amazon EFS User Guide>.
187  
188  
189  
190 =head2 Tags => ArrayRef[L<Paws::EFS::Tag>]
191  
192 A value that specifies to create one or more tags associated with the
193 file system. Each tag is a user-defined key-value pair. Name your file
194 system on creation by including a C<"Key":"Name","Value":"{value}">
195 key-value pair.
196  
197  
198  
199 =head2 ThroughputMode => Str
200  
201 Specifies the throughput mode for the file system, either C<bursting>
202 or C<provisioned>. If you set C<ThroughputMode> to C<provisioned>, you
203 must also set a value for C<ProvisionedThroughputInMibps>. After you
204 create the file system, you can decrease your file system's throughput
205 in Provisioned Throughput mode or change between the throughput modes,
206 as long as itE<rsquo>s been more than 24 hours since the last decrease
207 or throughput mode change. For more information, see Specifying
208 throughput with provisioned mode
209 (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput)
210 in the I<Amazon EFS User Guide>.
211  
212 Default is C<bursting>.
213  
214 Valid values are: C<"bursting">, C<"provisioned">
215  
216  
217 =head1 SEE ALSO
218  
219 This class forms part of L<Paws>, documenting arguments for method CreateFileSystem in L<Paws::EFS>
220  
221 =head1 BUGS and CONTRIBUTIONS
222  
223 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
224  
225 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
226  
227 =cut
228  
« blib/lib/Paws/EC2/VpnStaticRoute.pm ↑ Summary blib/lib/Paws/EFS/DeleteFileSystem.pm »