Enum SecretBackends

pub enum SecretBackends {
    File(FileBackend),
    Directory(DirectoryBackend),
    Exec(ExecBackend),
    AwsSecretsManager(AwsSecretsManagerBackend),
    Test(TestBackend),
}

Configuration options to retrieve secrets from external backend in order to avoid storing secrets in plaintext in Vector config. Multiple backends can be configured. Use SECRET[<backend_name>.<secret_key>] to tell Vector to retrieve the secret. This placeholder is replaced by the secret retrieved from the relevant backend.

When type is exec, the provided command will be run and provided a list of secrets to fetch, determined from the configuration file, on stdin as JSON in the format:

{"version": "1.0", "secrets": ["secret1", "secret2"]}

The executable is expected to respond with the values of these secrets on stdout, also as JSON, in the format:

{
    "secret1": {"value": "secret_value", "error": null},
    "secret2": {"value": null, "error": "could not fetch the secret"}
}

If an error is returned for any secrets, or if the command exits with a non-zero status code, Vector will log the errors and exit.

Otherwise, the secret must be a JSON text string with key/value pairs. For example:

{
    "username": "test",
    "password": "example-password"
}

If an error occurred while reading the file or retrieving the secrets, Vector logs the error and exits.

Secrets are loaded when Vector starts or if Vector receives a SIGHUP signal triggering its configuration reload process.

Variants

File(FileBackend)

File.

Directory(DirectoryBackend)

Directory.

Exec(ExecBackend)

Exec.

AwsSecretsManager(AwsSecretsManagerBackend)

AWS Secrets Manager.

Test(TestBackend)

Test.

Trait Implementations

impl Clone for SecretBackends

fn clone(&self) -> SecretBackends

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for SecretBackends

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for SecretBackends

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretBackends

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for SecretBackends

fn generate_config() -> Value

impl NamedComponent for SecretBackends

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl SecretBackend for SecretBackends

async fn retrieve( &mut self, __enum_dispatch_arg_0: HashSet<String>, __enum_dispatch_arg_1: &mut SignalRx, ) -> Result<HashMap<String, String>>

impl Serialize for SecretBackends

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for SecretBackends

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.