Struct CreateKeyRequestBuilder

pub struct CreateKeyRequestBuilder { /* private fields */ }

Builder for CreateKeyRequest.

Implementations

impl CreateKeyRequestBuilder

pub fn mount<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

pub fn name<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Specifies the name of the encryption key to create.

pub fn convergent_encryption<VALUE: Into<bool>>( &mut self, value: VALUE, ) -> &mut Self

If enabled, the key will support convergent encryption, where the same plaintext creates the same ciphertext. This requires derived to be set to true. When enabled, each encryption(/decryption/rewrap/datakey) operation will derive a nonce value rather than randomly generate it.

pub fn derived<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Specifies if key derivation is to be used. If enabled, all encrypt/decrypt requests to this named key must provide a context which is used for key derivation.

pub fn exportable<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Enables keys to be exportable. This allows for all the valid keys in the key ring to be exported. Once set, this cannot be disabled.

pub fn allow_plaintext_backup<VALUE: Into<bool>>( &mut self, value: VALUE, ) -> &mut Self

If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.

pub fn key_type<VALUE: Into<KeyType>>(&mut self, value: VALUE) -> &mut Self

Specifies the type of key to create.

pub fn auto_rotate_period<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

The period at which this key should be rotated automatically. Setting this to “0” (the default) will disable automatic key rotation. This value cannot be shorter than one hour.

pub fn build(&self) -> Result<CreateKeyRequest, CreateKeyRequestBuilderError>

Builds a new CreateKeyRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateKeyRequestBuilder

fn clone(&self) -> CreateKeyRequestBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CreateKeyRequestBuilder

fn default() -> Self

Returns the “default value” for a type.