package Paws::KMS::GenerateDataKey; use Moose; has EncryptionContext => (is => 'ro', isa => 'Paws::KMS::EncryptionContextType'); has GrantTokens => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has KeyId => (is => 'ro', isa => 'Str', required => 1); has KeySpec => (is => 'ro', isa => 'Str'); has NumberOfBytes => (is => 'ro', isa => 'Int'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'GenerateDataKey'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::GenerateDataKeyResponse'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::KMS::GenerateDataKey - Arguments for method GenerateDataKey on L =head1 DESCRIPTION This class represents the parameters used for calling the method GenerateDataKey on the L service. Use the attributes of this class as arguments to method GenerateDataKey. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GenerateDataKey. =head1 SYNOPSIS my $kms = Paws->service('KMS'); # To generate a data key # The following example generates a 256-bit symmetric data encryption key (data # key) in two formats. One is the unencrypted (plainext) data key, and the other # is the data key encrypted with the specified customer master key (CMK). my $GenerateDataKeyResponse = $kms->GenerateDataKey( 'KeyId' => 'alias/ExampleAlias', 'KeySpec' => 'AES_256' ); # Results: my $CiphertextBlob = $GenerateDataKeyResponse->CiphertextBlob; my $KeyId = $GenerateDataKeyResponse->KeyId; my $Plaintext = $GenerateDataKeyResponse->Plaintext; # Returns a L object. 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. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 EncryptionContext => L Specifies the encryption context that will be used when encrypting the data key. An I is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended. For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the I. =head2 GrantTokens => ArrayRef[Str|Undef] A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved I. For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) in the I. =head2 B KeyId => Str Identifies the symmetric CMK that encrypts the data key. To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with C<"alias/">. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: =over =item * Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> =item * Key ARN: C =item * Alias name: C =item * Alias ARN: C =back To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases. =head2 KeySpec => Str Specifies the length of the data key. Use C to generate a 128-bit symmetric key, or C to generate a 256-bit symmetric key. You must specify either the C or the C parameter (but not both) in every C request. Valid values are: C<"AES_256">, C<"AES_128"> =head2 NumberOfBytes => Int Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the C parameter. You must specify either the C or the C parameter (but not both) in every C request. =head1 SEE ALSO This class forms part of L, documenting arguments for method GenerateDataKey in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut