Struct rusoto_kms::EncryptRequest

pub struct EncryptRequest {
    pub encryption_algorithm: Option<String>,
    pub encryption_context: Option<HashMap<String, String>>,
    pub grant_tokens: Option<Vec<String>>,
    pub key_id: String,
    pub plaintext: Bytes,
}

Fields

encryption_algorithm: Option<String>

Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.

This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.

encryption_context: Option<HashMap<String, String>>

Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

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 in the AWS Key Management Service Developer Guide.

grant_tokens: Option<Vec<String>>

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

key_id: String

A unique identifier for the customer master key (CMK).

To specify a CMK, use its key ID, Amazon Resource Name (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.

plaintext: Bytes

Data to be encrypted.

Trait Implementations

impl Clone for EncryptRequest

pub fn clone(&self) -> EncryptRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncryptRequest

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EncryptRequest

pub fn default() -> EncryptRequest

Returns the "default value" for a type.

impl PartialEq<EncryptRequest> for EncryptRequest

pub fn eq(&self, other: &EncryptRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &EncryptRequest) -> bool

This method tests for !=.

impl Serialize for EncryptRequest

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EncryptRequest