Struct aws_sdk_kms::operation::generate_data_key::builders::GenerateDataKeyOutputBuilder

#[non_exhaustive]
pub struct GenerateDataKeyOutputBuilder { /* private fields */ }

A builder for GenerateDataKeyOutput.

Implementations

impl GenerateDataKeyOutputBuilder

pub fn ciphertext_blob(self, input: Blob) -> Self

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 set_ciphertext_blob(self, input: Option<Blob>) -> Self

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 get_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, input: Blob) -> Self

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 set_plaintext(self, input: Option<Blob>) -> Self

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 get_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, input: impl Into<String>) -> Self

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

pub fn set_key_id(self, input: Option<String>) -> Self

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

pub fn get_key_id(&self) -> &Option<String>

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

pub fn ciphertext_for_recipient(self, input: Blob) -> Self

The plaintext 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.

pub fn set_ciphertext_for_recipient(self, input: Option<Blob>) -> Self

The plaintext 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.

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

The plaintext 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.

pub fn build(self) -> GenerateDataKeyOutput

Consumes the builder and constructs a GenerateDataKeyOutput.

Trait Implementations

impl Clone for GenerateDataKeyOutputBuilder

fn clone(&self) -> GenerateDataKeyOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateDataKeyOutputBuilder

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

Formats the value using the given formatter.

impl Default for GenerateDataKeyOutputBuilder

fn default() -> GenerateDataKeyOutputBuilder

Returns the “default value” for a type.

impl PartialEq for GenerateDataKeyOutputBuilder

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

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

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

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

impl StructuralPartialEq for GenerateDataKeyOutputBuilder