File Coverage

blib/lib/Paws/KMS/Encrypt.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::KMS::Encrypt;
3 1     1   572 use Moose;
  1         3  
  1         9  
4             has EncryptionContext => (is => 'ro', isa => 'Paws::KMS::EncryptionContextType');
5             has GrantTokens => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has KeyId => (is => 'ro', isa => 'Str', required => 1);
7             has Plaintext => (is => 'ro', isa => 'Str', required => 1);
8              
9 1     1   6737 use MooseX::ClassAttribute;
  1         3  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'Encrypt');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::EncryptResponse');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::KMS::Encrypt - Arguments for method Encrypt on Paws::KMS
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method Encrypt on the
25             AWS Key Management Service service. Use the attributes of this class
26             as arguments to method Encrypt.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Encrypt.
29              
30             As an example:
31              
32             $service_obj->Encrypt(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 EncryptionContext => L<Paws::KMS::EncryptionContextType>
40              
41             Name-value pair that specifies the encryption context to be used for
42             authenticated encryption. If used here, the same value must be supplied
43             to the C<Decrypt> API or decryption will fail. For more information,
44             see Encryption Context.
45              
46              
47              
48             =head2 GrantTokens => ArrayRef[Str|Undef]
49              
50             A list of grant tokens.
51              
52             For more information, see Grant Tokens in the I<AWS Key Management
53             Service Developer Guide>.
54              
55              
56              
57             =head2 B<REQUIRED> KeyId => Str
58              
59             A unique identifier for the customer master key. This value can be a
60             globally unique identifier, a fully specified ARN to either an alias or
61             a key, or an alias name prefixed by "alias/".
62              
63             =over
64              
65             =item *
66              
67             Key ARN Example -
68             arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
69              
70             =item *
71              
72             Alias ARN Example -
73             arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
74              
75             =item *
76              
77             Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
78              
79             =item *
80              
81             Alias Name Example - alias/MyAliasName
82              
83             =back
84              
85              
86              
87              
88             =head2 B<REQUIRED> Plaintext => Str
89              
90             Data to be encrypted.
91              
92              
93              
94              
95             =head1 SEE ALSO
96              
97             This class forms part of L<Paws>, documenting arguments for method Encrypt in L<Paws::KMS>
98              
99             =head1 BUGS and CONTRIBUTIONS
100              
101             The source code is located here: https://github.com/pplu/aws-sdk-perl
102              
103             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
104              
105             =cut
106