Struct CreateKeyRequest

pub struct CreateKeyRequest {
    pub mount: String,
    pub name: String,
    pub convergent_encryption: Option<bool>,
    pub derived: Option<bool>,
    pub exportable: Option<bool>,
    pub allow_plaintext_backup: Option<bool>,
    pub key_type: Option<KeyType>,
    pub auto_rotate_period: Option<String>,
}

Create Key

This endpoint creates a new named encryption key of the specified type. The values set here cannot be changed after key creation.

• Path: {self.mount}/keys/{self.name}
• Method: POST
• Response: N/A
• Reference: https://developer.hashicorp.com/vault/api-docs/secret/transit#create-key

Fields

mount: String

name: String

Specifies the name of the encryption key to create.

convergent_encryption: Option<bool>

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.

derived: Option<bool>

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.

exportable: Option<bool>

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.

allow_plaintext_backup: Option<bool>

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

key_type: Option<KeyType>

Specifies the type of key to create.

auto_rotate_period: Option<String>

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.

Implementations

impl CreateKeyRequest

pub fn builder() -> CreateKeyRequestBuilder

Trait Implementations

impl Debug for CreateKeyRequest

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

Formats the value using the given formatter.

impl Default for CreateKeyRequest

fn default() -> CreateKeyRequest

Returns the “default value” for a type.

impl Endpoint for CreateKeyRequest

const REQUEST_BODY_TYPE: RequestType = RequestType::JSON

The content type of the request body

const RESPONSE_BODY_TYPE: ResponseType = ResponseType::JSON

The content type of the response body

type Response = ()

The type that the raw response from executing this endpoint will deserialized into. This type is passed on to the EndpointResult and is used to determine the type returned when the parse() method is called.

fn path(&self) -> String

The relative URL path that represents the location of this Endpoint. This is combined with the base URL from a Client instance to create the fully qualified URL.

fn method(&self) -> RequestMethod

The HTTP method to be used when executing this Endpoint.

fn body(&self) -> Result<Option<Vec<u8>>, ClientError>

Optional data to add to the body of the request.

fn query(&self) -> Result<Option<String>, ClientError>

Optional query parameters to add to the request.

fn url(&self, base: &str) -> Result<Uri, ClientError>

Returns the full URL address of the endpoint using the base address.

fn request(&self, base: &str) -> Result<Request<Vec<u8>>, ClientError>

Returns a Request containing all data necessary to execute against this endpoint.

fn exec<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 (impl Client + 'async_trait), ) -> Pin<Box<dyn Future<Output = Result<EndpointResult<Self::Response>, ClientError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Executes the Endpoint using the given Client.

fn with_middleware<M>(self, middleware: &M) -> MutatedEndpoint<'_, Self, M>

where M: MiddleWare,

impl Serialize for CreateKeyRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.