Struct CreateAwsKmsHierarchicalKeyringInput 

#[non_exhaustive]
pub struct CreateAwsKmsHierarchicalKeyringInput {
    pub branch_key_id: Option<String>,
    pub branch_key_id_supplier: Option<BranchKeyIdSupplierRef>,
    pub cache: Option<CacheType>,
    pub key_store: Option<Client>,
    pub partition_id: Option<String>,
    pub ttl_seconds: Option<i64>,
}

Inputs for creating a Hierarchical Keyring.

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.

branch_key_id: Option<String>

The identifier for the single Branch Key responsible for wrapping and unwrapping the data key. Either a Branch Key ID or Branch Key Supplier must be specified.

branch_key_id_supplier: Option<BranchKeyIdSupplierRef>

A Branch Key Supplier which determines what Branch Key to use to wrap and unwrap the data key. Either a Branch Key ID or Branch Key Supplier must be specified.

cache: Option<CacheType>

Sets the type of cache for this Hierarchical Keyring. By providing an already initialized ‘Shared’ cache, users can determine the scope of the cache. That is, if the cache is shared across other Cryptographic Material Providers, for instance other Hierarchical Keyrings or Caching Cryptographic Materials Managers (Caching CMMs). If any other type of cache in the CacheType union is provided, the Hierarchical Keyring will initialize a cache of that type, to be used with only this Hierarchical Keyring. If not set, a DefaultCache is initialized to be used with only this Hierarchical Keyring with entryCapacity = 1000.

key_store: Option<Client>

The Key Store which contains the Branch Key(s) responsible for wrapping and unwrapping data keys.

partition_id: Option<String>

Partition ID to distinguish Cryptographic Material Providers (i.e: Keyrings) writing to a cache. If the Partition ID is the same for two Hierarchical Keyrings (or another Material Provider), they can share the same cache entries in the cache.

ttl_seconds: Option<i64>

How many seconds the Branch Key material is allowed to be reused within the local cache before it is re-retrieved from Amazon DynamoDB and re-authenticated with AWS KMS.

Implementations

impl CreateAwsKmsHierarchicalKeyringInput

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

The identifier for the single Branch Key responsible for wrapping and unwrapping the data key. Either a Branch Key ID or Branch Key Supplier must be specified.

pub fn branch_key_id_supplier(&self) -> &Option<BranchKeyIdSupplierRef>

A Branch Key Supplier which determines what Branch Key to use to wrap and unwrap the data key. Either a Branch Key ID or Branch Key Supplier must be specified.

pub fn cache(&self) -> &Option<CacheType>

Sets the type of cache for this Hierarchical Keyring. By providing an already initialized ‘Shared’ cache, users can determine the scope of the cache. That is, if the cache is shared across other Cryptographic Material Providers, for instance other Hierarchical Keyrings or Caching Cryptographic Materials Managers (Caching CMMs). If any other type of cache in the CacheType union is provided, the Hierarchical Keyring will initialize a cache of that type, to be used with only this Hierarchical Keyring. If not set, a DefaultCache is initialized to be used with only this Hierarchical Keyring with entryCapacity = 1000.

pub fn key_store(&self) -> &Option<Client>

The Key Store which contains the Branch Key(s) responsible for wrapping and unwrapping data keys.

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

Partition ID to distinguish Cryptographic Material Providers (i.e: Keyrings) writing to a cache. If the Partition ID is the same for two Hierarchical Keyrings (or another Material Provider), they can share the same cache entries in the cache.

pub fn ttl_seconds(&self) -> &Option<i64>

How many seconds the Branch Key material is allowed to be reused within the local cache before it is re-retrieved from Amazon DynamoDB and re-authenticated with AWS KMS.

impl CreateAwsKmsHierarchicalKeyringInput

pub fn builder() -> CreateAwsKmsHierarchicalKeyringInputBuilder

Creates a new builder-style object to manufacture CreateAwsKmsHierarchicalKeyringInput.

Trait Implementations

impl Clone for CreateAwsKmsHierarchicalKeyringInput

fn clone(&self) -> CreateAwsKmsHierarchicalKeyringInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAwsKmsHierarchicalKeyringInput

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

Formats the value using the given formatter.

impl PartialEq for CreateAwsKmsHierarchicalKeyringInput

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