Struct GenerateDataKeyPairOutput

#[non_exhaustive]
pub struct GenerateDataKeyPairOutput {
    pub private_key_ciphertext_blob: Option<Blob>,
    pub private_key_plaintext: Option<Blob>,
    pub public_key: Option<Blob>,
    pub key_id: Option<String>,
    pub key_pair_spec: Option<DataKeyPairSpec>,
    pub ciphertext_for_recipient: Option<Blob>,
    /* 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.

private_key_ciphertext_blob: Option<Blob>

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

private_key_plaintext: Option<Blob>

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

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

public_key: Option<Blob>

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

key_id: Option<String>

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

key_pair_spec: Option<DataKeyPairSpec>

The type of data key pair that was generated.

ciphertext_for_recipient: Option<Blob>

The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

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. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Implementations

impl GenerateDataKeyPairOutput

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

The encrypted copy of the private 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 private_key_plaintext(&self) -> Option<&Blob>

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

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

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

The public key (in plaintext). 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 key_id(&self) -> Option<&str>

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

pub fn key_pair_spec(&self) -> Option<&DataKeyPairSpec>

The type of data key pair that was generated.

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

The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

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. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

impl GenerateDataKeyPairOutput

pub fn builder() -> GenerateDataKeyPairOutputBuilder

Creates a new builder-style object to manufacture GenerateDataKeyPairOutput.

Trait Implementations

impl Clone for GenerateDataKeyPairOutput

fn clone(&self) -> GenerateDataKeyPairOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateDataKeyPairOutput

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

Formats the value using the given formatter.

impl PartialEq for GenerateDataKeyPairOutput

fn eq(&self, other: &GenerateDataKeyPairOutput) -> 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 GenerateDataKeyPairOutput

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

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

impl StructuralPartialEq for GenerateDataKeyPairOutput