StandardHashiCorpVaultClientService

StandardHashiCorpVaultClientService 2.0.0

Bundle: org.apache.nifi | nifi-hashicorp-vault-nar
Description: A controller service for interacting with HashiCorp Vault.
Tags: client, hashicorp, vault
Input Requirement
Supports Sensitive Dynamic Properties: true

Properties

Configuration Strategy
Specifies the source of the configuration properties.
Display Name

Configuration Strategy

Description

Specifies the source of the configuration properties.

API Name

configuration-strategy

Default Value

direct-properties

Allowable Values
- Direct Properties
- Properties Files
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Vault Authentication
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).
Display Name

Vault Authentication

Description

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).

API Name

vault.authentication

Default Value

TOKEN

Allowable Values
- TOKEN
- APPID
- APPROLE
- AWS_EC2
- AZURE
- CERT
- CUBBYHOLE
- KUBERNETES
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Configuration Strategy is set to any of [direct-properties]
Connection Timeout
The connection timeout for the HashiCorp Vault client

Display Name

Connection Timeout

Description

The connection timeout for the HashiCorp Vault client

API Name

vault.connection.timeout

Default Value

5 sec

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Vault Properties Files
A 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.
Display Name

Vault Properties Files

Description

A 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.

API Name

vault.properties.files

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Configuration Strategy is set to any of [properties-files]
Read Timeout
The read timeout for the HashiCorp Vault client

Display Name

Read Timeout

Description

The read timeout for the HashiCorp Vault client

API Name

vault.read.timeout

Default Value

15 sec

Expression Language Scope

Not Supported

Sensitive

false

Required

true
SSL Context Service
The SSL Context Service used to provide client certificate information for TLS/SSL connections to the HashiCorp Vault server.
Display Name

SSL Context Service

Description

The SSL Context Service used to provide client certificate information for TLS/SSL connections to the HashiCorp Vault server.

API Name

vault.ssl.context.service

Service Interface

org.apache.nifi.ssl.SSLContextService

Service Implementations

org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Configuration Strategy is set to any of [direct-properties]
Vault URI
The URI of the HashiCorp Vault server (e.g., http://localhost:8200). Required if not specified in the Bootstrap HashiCorp Vault Configuration File.
Display Name

Vault URI

Description

The URI of the HashiCorp Vault server (e.g., http://localhost:8200). Required if not specified in the Bootstrap HashiCorp Vault Configuration File.

API Name

vault.uri

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true

Dependencies
- Configuration Strategy is set to any of [direct-properties]

Dynamic Properties

A Spring Vault configuration property name
Allows 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.

Name

A Spring Vault configuration property name

Description

Allows 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.

Value

The property value

Expression Language Scope

ENVIRONMENT