class Aws::KMS::Types::EncryptRequest

@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncryptRequest AWS API Documentation
@return [Boolean]<br>: docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html<br><br><br><br>permissions][1] in the *Key Management Service Developer Guide*.
To learn more about how to use this parameter, see [Testing your
parameter.
Checks if your request will succeed. ‘DryRun` is an optional
@!attribute [rw] dry_run
@return [String]
The SM2PKE algorithm is only available in China Regions.
recommend RSAES_OAEP_SHA_256.
encryption KMS keys. If you are using an asymmetric KMS key, we
value, `SYMMETRIC_DEFAULT`, is the algorithm used for symmetric
This parameter is required only for asymmetric KMS keys. The default
that you specify.
plaintext message. The algorithm must be compatible with the KMS key
Specifies the encryption algorithm that KMS will use to encrypt the
@!attribute [rw] encryption_algorithm
@return [Array<String>]<br>: docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html<br>[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token<br><br><br><br>token][2] in the *Key Management Service Developer Guide*.
For more information, see [Grant token] and [Using a grant
from a new grant that has not yet achieved *eventual consistency*.
Use a grant token when your permission to call this operation comes
A list of grant tokens.
@!attribute [rw] grant_tokens
@return [Hash<String,String>]<br>: docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html<br>[1]: docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations<br><br><br><br>Management Service Developer Guide*.
For more information, see [Encryption context] in the *Key
recommended.
keys, an encryption context is optional, but it is strongly
encryption KMS keys. On operations with symmetric encryption KMS
An encryption context is supported only on operations with symmetric
exact case-sensitive match) encryption context to decrypt the data.
encryption context to encrypt data, you must specify the same (an
pairs that represent additional authenticated data. When you use an
An *encryption context* is a collection of non-secret key-value
other output.
This field may be displayed in plaintext in CloudTrail logs and
Do not include confidential or sensitive information in this field.
do not support an encryption context.
asymmetric encryption algorithms and HMAC algorithms that KMS uses<br>operations] with a symmetric encryption KMS key. The standard
data. An encryption context is valid only for [cryptographic
Specifies the encryption context that will be used to encrypt the
@!attribute [rw] encryption_context
@return [String]
Data to be encrypted.
@!attribute [rw] plaintext
@return [String]
DescribeKey. To get the alias name and alias ARN, use ListAliases.
To get the key ID and key ARN for a KMS key, use ListKeys or
* Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
* Alias name: `alias/ExampleAlias`
`arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
* Key ARN:
* Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
For example:
the key ARN or alias ARN.
a KMS key in a different Amazon Web Services account, you must use
ARN. When using an alias name, prefix it with `“alias/”`. To specify
To specify a KMS key, use its key ID, key ARN, alias name, or alias
`KeyUsage` of a KMS key, use the DescribeKey operation.
key must have a `KeyUsage` of `ENCRYPT_DECRYPT`. To find the
Identifies the KMS key to use in the encryption operation. The KMS
@!attribute [rw] key_id