blib/lib/Paws/ElasticTranscoder/Encryption.pm untested

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ElasticTranscoder::Encryption;
3 use Moose;
4 has InitializationVector => (is => 'ro', isa => 'Str');
5 has Key => (is => 'ro', isa => 'Str');
6 has KeyMd5 => (is => 'ro', isa => 'Str');
7 has Mode => (is => 'ro', isa => 'Str');
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::ElasticTranscoder::Encryption
16  
17 =head1 USAGE
18  
19 This class represents one of two things:
20  
21 =head3 Arguments in a call to a service
22  
23 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24 Each attribute should be used as a named argument in the calls that expect this type of object.
25  
26 As an example, if Att1 is expected to be a Paws::ElasticTranscoder::Encryption object:
27  
28 $service_obj->Method(Att1 => { InitializationVector => $value, ..., Mode => $value });
29  
30 =head3 Results returned from an API call
31  
32 Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::Encryption object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->InitializationVector
36  
37 =head1 DESCRIPTION
38  
39 The encryption settings, if any, that are used for decrypting your
40 input files or encrypting your output files. If your input file is
41 encrypted, you must specify the mode that Elastic Transcoder uses to
42 decrypt your file, otherwise you must specify the mode you want Elastic
43 Transcoder to use to encrypt your output files.
44  
45 =head1 ATTRIBUTES
46  
47  
48 =head2 InitializationVector => Str
49  
50 The series of random bits created by a random bit generator, unique for
51 every encryption operation, that you used to encrypt your input files
52 or that you want Elastic Transcoder to use to encrypt your output
53 files. The initialization vector must be base64-encoded, and it must be
54 exactly 16 bytes long before being base64-encoded.
55  
56  
57 =head2 Key => Str
58  
59 The data encryption key that you want Elastic Transcoder to use to
60 encrypt your output file, or that was used to encrypt your input file.
61 The key must be base64-encoded and it must be one of the following bit
62 lengths before being base64-encoded:
63  
64 C<128>, C<192>, or C<256>.
65  
66 The key must also be encrypted by using the Amazon Key Management
67 Service.
68  
69  
70 =head2 KeyMd5 => Str
71  
72 The MD5 digest of the key that you used to encrypt your input file, or
73 that you want Elastic Transcoder to use to encrypt your output file.
74 Elastic Transcoder uses the key digest as a checksum to make sure your
75 key was not corrupted in transit. The key MD5 must be base64-encoded,
76 and it must be exactly 16 bytes long before being base64-encoded.
77  
78  
79 =head2 Mode => Str
80  
81 The specific server-side encryption mode that you want Elastic
82 Transcoder to use when decrypting your input files or encrypting your
83 output files. Elastic Transcoder supports the following options:
84  
85 =over
86  
87 =item *
88  
89 B<s3:> Amazon S3 creates and manages the keys used for encrypting your
90 files.
91  
92 =item *
93  
94 B<s3-aws-kms:> Amazon S3 calls the Amazon Key Management Service, which
95 creates and manages the keys that are used for encrypting your files.
96 If you specify C<s3-aws-kms> and you don't want to use the default key,
97 you must add the AWS-KMS key that you want to use to your pipeline.
98  
99 =item *
100  
101 B<aes-cbc-pkcs7:> A padded cipher-block mode of operation originally
102 used for HLS files.
103  
104 =item *
105  
106 B<aes-ctr:> AES Counter Mode.
107  
108 =item *
109  
110 B<aes-gcm:> AES Galois Counter Mode, a mode of operation that is an
111 authenticated encryption format, meaning that a file, key, or
112 initialization vector that has been tampered with fails the decryption
113 process.
114  
115 =back
116  
117 For all three AES options, you must provide the following settings,
118 which must be base64-encoded:
119  
120 =over
121  
122 =item *
123  
124 B<Key>
125  
126 =item *
127  
128 B<Key MD5>
129  
130 =item *
131  
132 B<Initialization Vector>
133  
134 =back
135  
136 For the AES modes, your private encryption keys and your unencrypted
137 data are never stored by AWS; therefore, it is important that you
138 safely manage your encryption keys. If you lose them, you won't be able
139 to unencrypt your data.
140  
141  
142  
143 =head1 SEE ALSO
144  
145 This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
146  
147 =head1 BUGS and CONTRIBUTIONS
148  
149 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
150  
151 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
152  
153 =cut
154