/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::KMS::GenerateDataKeyPair

NAME

Paws::KMS::GenerateDataKeyPair - Arguments for method GenerateDataKeyPair on Paws::KMS

DESCRIPTION

This class represents the parameters used for calling the method GenerateDataKeyPair on the AWS Key Management Service service. Use the attributes of this class as arguments to method GenerateDataKeyPair.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GenerateDataKeyPair.

SYNOPSIS

my $kms = Paws->service('KMS');
my $GenerateDataKeyPairResponse = $kms->GenerateDataKeyPair(
  KeyId             => 'MyKeyIdType',
  KeyPairSpec       => 'RSA_2048',
  EncryptionContext =>
    { 'MyEncryptionContextKey' => 'MyEncryptionContextValue', },  # OPTIONAL
  GrantTokens => [
    'MyGrantTokenType', ...    # min: 1, max: 8192
  ],    # OPTIONAL
);

# Results:
my $KeyId       = $GenerateDataKeyPairResponse->KeyId;
my $KeyPairSpec = $GenerateDataKeyPairResponse->KeyPairSpec;
my $PrivateKeyCiphertextBlob =
  $GenerateDataKeyPairResponse->PrivateKeyCiphertextBlob;
my $PrivateKeyPlaintext = $GenerateDataKeyPairResponse->PrivateKeyPlaintext;
my $PublicKey           = $GenerateDataKeyPairResponse->PublicKey;

# Returns a L<Paws::KMS::GenerateDataKeyPairResponse> 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 https://docs.aws.amazon.com/goto/WebAPI/kms/GenerateDataKeyPair

ATTRIBUTES

EncryptionContext => Paws::KMS::EncryptionContextType

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context 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 AWS Key Management Service Developer Guide.

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 eventual consistency. For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) in the AWS Key Management Service Developer Guide.

REQUIRED KeyId => Str

Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

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.

REQUIRED KeyPairSpec => Str

Determines the type of data key pair that is generated.

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

Valid values are: "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1"

SEE ALSO

This class forms part of Paws, documenting arguments for method GenerateDataKeyPair in Paws::KMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues