Struct DynamoDbTableEncryptionConfig 

#[non_exhaustive]
pub struct DynamoDbTableEncryptionConfig {
    pub algorithm_suite_id: Option<DbeAlgorithmSuiteId>,
    pub allowed_unsigned_attribute_prefix: Option<String>,
    pub allowed_unsigned_attributes: Option<Vec<String>>,
    pub attribute_actions_on_encrypt: Option<HashMap<String, CryptoAction>>,
    pub cmm: Option<CryptographicMaterialsManagerRef>,
    pub keyring: Option<KeyringRef>,
    pub legacy_override: Option<LegacyOverride>,
    pub logical_table_name: Option<String>,
    pub partition_key_name: Option<String>,
    pub plaintext_override: Option<PlaintextOverride>,
    pub search: Option<SearchConfig>,
    pub sort_key_name: Option<String>,
}

The configuration for client-side encryption for a particular DynamoDB table.

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.

algorithm_suite_id: Option<DbeAlgorithmSuiteId>

An ID for the algorithm suite to use during encryption and decryption.

allowed_unsigned_attribute_prefix: Option<String>

A prefix such that, if during decryption any attribute has a name with this prefix, it is treated as unsigned.

allowed_unsigned_attributes: Option<Vec<String>>

A list of attribute names such that, if encountered during decryption, those attributes are treated as unsigned.

attribute_actions_on_encrypt: Option<HashMap<String, CryptoAction>>

A map that describes what attributes should be encrypted and/or signed on encrypt. This map must contain all attributes that might be encountered during encryption.

cmm: Option<CryptographicMaterialsManagerRef>

The Cryptographic Materials Manager that is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.

keyring: Option<KeyringRef>

The Keyring that should be used to wrap and unwrap data keys. If specified a Default Cryptographic Materials Manager with this Keyring is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.

legacy_override: Option<LegacyOverride>

A configuration that override encryption and/or decryption to instead perform legacy encryption and/or decryption. Used as part of migration from version 2.x to version 3.x.

logical_table_name: Option<String>

The logical table name for this table. This is the name that is cryptographically bound with your data. This can be the same as the actual DynamoDB table name. It’s purpose is to be distinct from the DynamoDB table name so that the data may still be authenticated if being read from different (but logically similar) tables, such as a backup table.

partition_key_name: Option<String>

The name of the partition key on this table.

plaintext_override: Option<PlaintextOverride>

A configuration that override encryption and/or decryption to instead passthrough and write and/or read plaintext. Used to update plaintext tables to fully use client-side encryption.

search: Option<SearchConfig>

The configuration for searchable encryption.

sort_key_name: Option<String>

If this table contains a sort key, the name of the sort key on this table.

Implementations

impl DynamoDbTableEncryptionConfig

pub fn algorithm_suite_id(&self) -> &Option<DbeAlgorithmSuiteId>

An ID for the algorithm suite to use during encryption and decryption.

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

A prefix such that, if during decryption any attribute has a name with this prefix, it is treated as unsigned.

pub fn allowed_unsigned_attributes(&self) -> &Option<Vec<String>>

A list of attribute names such that, if encountered during decryption, those attributes are treated as unsigned.

pub fn attribute_actions_on_encrypt( &self, ) -> &Option<HashMap<String, CryptoAction>>

A map that describes what attributes should be encrypted and/or signed on encrypt. This map must contain all attributes that might be encountered during encryption.

pub fn cmm(&self) -> &Option<CryptographicMaterialsManagerRef>

The Cryptographic Materials Manager that is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.

pub fn keyring(&self) -> &Option<KeyringRef>

The Keyring that should be used to wrap and unwrap data keys. If specified a Default Cryptographic Materials Manager with this Keyring is used to obtain materials for encryption and decryption. Either a Keyring or a Cryptographic Materials Manager must be specified.

pub fn legacy_override(&self) -> &Option<LegacyOverride>

A configuration that override encryption and/or decryption to instead perform legacy encryption and/or decryption. Used as part of migration from version 2.x to version 3.x.

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

The logical table name for this table. This is the name that is cryptographically bound with your data. This can be the same as the actual DynamoDB table name. It’s purpose is to be distinct from the DynamoDB table name so that the data may still be authenticated if being read from different (but logically similar) tables, such as a backup table.

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

The name of the partition key on this table.

pub fn plaintext_override(&self) -> &Option<PlaintextOverride>

A configuration that override encryption and/or decryption to instead passthrough and write and/or read plaintext. Used to update plaintext tables to fully use client-side encryption.

pub fn search(&self) -> &Option<SearchConfig>

The configuration for searchable encryption.

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

If this table contains a sort key, the name of the sort key on this table.

impl DynamoDbTableEncryptionConfig

pub fn builder() -> DynamoDbTableEncryptionConfigBuilder

Creates a new builder-style object to manufacture DynamoDbTableEncryptionConfig.

Trait Implementations

impl Clone for DynamoDbTableEncryptionConfig

fn clone(&self) -> DynamoDbTableEncryptionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamoDbTableEncryptionConfig

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

Formats the value using the given formatter.

impl PartialEq for DynamoDbTableEncryptionConfig

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