StandardHashiCorpVaultClientService

Description:

A controller service for interacting with HashiCorp Vault.

Additional Details...

Tags:

hashicorp, vault, client

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Configuration Strategyconfiguration-strategyDirect Properties
  • Direct Properties Use properties, including dynamic properties, configured directly in the Controller Service to configure the client
  • Properties Files Use one or more '.properties' files to configure the client
Specifies the source of the configuration properties.
Vault URIvault.uriThe URI of the HashiCorp Vault server (e.g., http://localhost:8200). Required if not specified in the Bootstrap HashiCorp Vault Configuration File.
Supports Expression Language: true (will be evaluated using variable registry only)

This Property is only considered if the [Configuration Strategy] Property has a value of "Direct Properties".
Vault Authenticationvault.authenticationTOKEN
  • TOKEN
  • APPID
  • APPROLE
  • AWS_EC2
  • AZURE
  • CERT
  • CUBBYHOLE
  • KUBERNETES
Vault authentication method, as described in the Spring Vault Environment Configuration documentation (https://docs.spring.io/spring-vault/docs/2.3.x/reference/html/#vault.core.environment-vault-configuration).

This Property is only considered if the [Configuration Strategy] Property has a value of "Direct Properties".
SSL Context Servicevault.ssl.context.serviceController Service API:
SSLContextService
Implementations: StandardSSLContextService
StandardRestrictedSSLContextService		The SSL Context Service used to provide client certificate information for TLS/SSL connections to the HashiCorp Vault server.

This Property is only considered if the [Configuration Strategy] Property has a value of "Direct Properties".
Vault Properties Filesvault.properties.filesA comma-separated list of files containing HashiCorp Vault configuration properties, as described in the Spring Vault Environment Configuration documentation (https://docs.spring.io/spring-vault/docs/2.3.x/reference/html/#vault.core.environment-vault-configuration). All of the Spring property keys and authentication-specific property keys are supported.

This property expects a comma-separated list of file resources.


This Property is only considered if the [Configuration Strategy] Property has a value of "Properties Files".
Connection Timeoutvault.connection.timeout5 secThe connection timeout for the HashiCorp Vault client
Read Timeoutvault.read.timeout15 secThe read timeout for the HashiCorp Vault client

Dynamic Properties:

Supports Sensitive Dynamic Properties: Yes

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
A Spring Vault configuration property nameThe property valueAllows any Spring Vault property keys to be specified, as described in (https://docs.spring.io/spring-vault/docs/2.3.x/reference/html/#vault.core.environment-vault-configuration). See Additional Details for more information.
Supports Expression Language: true (will be evaluated using variable registry only)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.