blib/lib/Paws/KMS/GenerateDataKeyPairWithoutPlaintext.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::KMS::GenerateDataKeyPairWithoutPlaintext;
3 use Moose;
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 KeyPairSpec => (is => 'ro', isa => 'Str', required => 1);
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GenerateDataKeyPairWithoutPlaintext');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::GenerateDataKeyPairWithoutPlaintextResponse');
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::GenerateDataKeyPairWithoutPlaintext - Arguments for method GenerateDataKeyPairWithoutPlaintext on L<Paws::KMS>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method GenerateDataKeyPairWithoutPlaintext on the
25 L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class
26 as arguments to method GenerateDataKeyPairWithoutPlaintext.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GenerateDataKeyPairWithoutPlaintext.
29  
30 =head1 SYNOPSIS
31  
32 my $kms = Paws->service('KMS');
33 my $GenerateDataKeyPairWithoutPlaintextResponse =
34 $kms->GenerateDataKeyPairWithoutPlaintext(
35 KeyId => 'MyKeyIdType',
36 KeyPairSpec => 'RSA_2048',
37 EncryptionContext =>
38 { 'MyEncryptionContextKey' => 'MyEncryptionContextValue', }, # OPTIONAL
39 GrantTokens => [
40 'MyGrantTokenType', ... # min: 1, max: 8192
41 ], # OPTIONAL
42 );
43  
44 # Results:
45 my $KeyId = $GenerateDataKeyPairWithoutPlaintextResponse->KeyId;
46 my $KeyPairSpec = $GenerateDataKeyPairWithoutPlaintextResponse->KeyPairSpec;
47 my $PrivateKeyCiphertextBlob =
48 $GenerateDataKeyPairWithoutPlaintextResponse->PrivateKeyCiphertextBlob;
49 my $PublicKey = $GenerateDataKeyPairWithoutPlaintextResponse->PublicKey;
50  
51 # Returns a L<Paws::KMS::GenerateDataKeyPairWithoutPlaintextResponse> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/GenerateDataKeyPairWithoutPlaintext>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 EncryptionContext => L<Paws::KMS::EncryptionContextType>
60  
61 Specifies the encryption context that will be used when encrypting the
62 private key in the data key pair.
63  
64 An I<encryption context> is a collection of non-secret key-value pairs
65 that represents additional authenticated data. When you use an
66 encryption context to encrypt data, you must specify the same (an exact
67 case-sensitive match) encryption context to decrypt the data. An
68 encryption context is optional when encrypting with a symmetric CMK,
69 but it is highly recommended.
70  
71 For more information, see Encryption Context
72 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
73 in the I<AWS Key Management Service Developer Guide>.
74  
75  
76  
77 =head2 GrantTokens => ArrayRef[Str|Undef]
78  
79 A list of grant tokens.
80  
81 Use a grant token when your permission to call this operation comes
82 from a new grant that has not yet achieved I<eventual consistency>. For
83 more information, see Grant token
84 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
85 in the I<AWS Key Management Service Developer Guide>.
86  
87  
88  
89 =head2 B<REQUIRED> KeyId => Str
90  
91 Specifies the CMK that encrypts the private key in the data key pair.
92 You must specify a symmetric CMK. You cannot use an asymmetric CMK or a
93 CMK in a custom key store. To get the type and origin of your CMK, use
94 the DescribeKey operation.
95  
96 To specify a CMK, use its key ID, key ARN, alias name, or alias ARN.
97 When using an alias name, prefix it with C<"alias/">. To specify a CMK
98 in a different AWS account, you must use the key ARN or alias ARN.
99  
100 For example:
101  
102 =over
103  
104 =item *
105  
106 Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab>
107  
108 =item *
109  
110 Key ARN:
111 C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab>
112  
113 =item *
114  
115 Alias name: C<alias/ExampleAlias>
116  
117 =item *
118  
119 Alias ARN: C<arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias>
120  
121 =back
122  
123 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
124 To get the alias name and alias ARN, use ListAliases.
125  
126  
127  
128 =head2 B<REQUIRED> KeyPairSpec => Str
129  
130 Determines the type of data key pair that is generated.
131  
132 The AWS KMS rule that restricts the use of asymmetric RSA CMKs to
133 encrypt and decrypt or to sign and verify (but not both), and the rule
134 that permits you to use ECC CMKs only to sign and verify, are not
135 effective outside of AWS KMS.
136  
137 Valid values are: C<"RSA_2048">, C<"RSA_3072">, C<"RSA_4096">, C<"ECC_NIST_P256">, C<"ECC_NIST_P384">, C<"ECC_NIST_P521">, C<"ECC_SECG_P256K1">
138  
139  
140 =head1 SEE ALSO
141  
142 This class forms part of L<Paws>, documenting arguments for method GenerateDataKeyPairWithoutPlaintext in L<Paws::KMS>
143  
144 =head1 BUGS and CONTRIBUTIONS
145  
146 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
147  
148 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
149  
150 =cut
151