Struct GenerateDataKeyOutput

#[non_exhaustive]
pub struct GenerateDataKeyOutput {
    pub ciphertext_blob: Option<Blob>,
    pub plaintext: Option<Blob>,
    pub key_id: Option<String>,
    pub ciphertext_for_recipient: Option<Blob>,
    pub key_material_id: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ciphertext_blob: Option<Blob>

The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

plaintext: Option<Blob>

The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

key_id: Option<String>

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

ciphertext_for_recipient: Option<Blob>

The plaintext data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

key_material_id: Option<String>

The identifier of the key material used to encrypt the data key. This field is omitted if the request includes the Recipient parameter.

Implementations

impl GenerateDataKeyOutput

pub fn ciphertext_blob(&self) -> Option<&Blob>

The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

pub fn plaintext(&self) -> Option<&Blob>

The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

pub fn key_id(&self) -> Option<&str>

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

pub fn ciphertext_for_recipient(&self) -> Option<&Blob>

The plaintext data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

pub fn key_material_id(&self) -> Option<&str>

The identifier of the key material used to encrypt the data key. This field is omitted if the request includes the Recipient parameter.

impl GenerateDataKeyOutput

pub fn builder() -> GenerateDataKeyOutputBuilder

Creates a new builder-style object to manufacture GenerateDataKeyOutput.

Trait Implementations

impl Clone for GenerateDataKeyOutput

fn clone(&self) -> GenerateDataKeyOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateDataKeyOutput

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

Formats the value using the given formatter.

impl PartialEq for GenerateDataKeyOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GenerateDataKeyOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GenerateDataKeyOutput