| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardHashiCorpVaultClientService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">StandardHashiCorpVaultClientService</h1><h2>Description: </h2><p>A controller service for interacting with HashiCorp Vault.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>hashicorp, vault, client</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Configuration Strategy</strong></td><td>configuration-strategy</td><td id="default-value">Direct Properties</td><td id="allowable-values"><ul><li>Direct Properties <img src="../../../../../html/images/iconInfo.png" alt="Use properties, including dynamic properties, configured directly in the Controller Service to configure the client" title="Use properties, including dynamic properties, configured directly in the Controller Service to configure the client"></img></li><li>Properties Files <img src="../../../../../html/images/iconInfo.png" alt="Use one or more '.properties' files to configure the client" title="Use one or more '.properties' files to configure the client"></img></li></ul></td><td id="description">Specifies the source of the configuration properties.</td></tr><tr><td id="name"><strong>Vault URI</strong></td><td>vault.uri</td><td></td><td id="allowable-values"></td><td id="description">The URI of the HashiCorp Vault server (e.g., http://localhost:8200). Required if not specified in the Bootstrap HashiCorp Vault Configuration File.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Configuration Strategy] Property has a value of "Direct Properties".</strong></td></tr><tr><td id="name"><strong>Vault Authentication</strong></td><td>vault.authentication</td><td id="default-value">TOKEN</td><td id="allowable-values"><ul><li>TOKEN</li><li>APPID</li><li>APPROLE</li><li>AWS_EC2</li><li>AZURE</li><li>CERT</li><li>CUBBYHOLE</li><li>KUBERNETES</li></ul></td><td id="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).<br/><br/><strong>This Property is only considered if </strong><strong>the [Configuration Strategy] Property has a value of "Direct Properties".</strong></td></tr><tr><td id="name">SSL Context Service</td><td>vault.ssl.context.service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections to the HashiCorp Vault server.<br/><br/><strong>This Property is only considered if </strong><strong>the [Configuration Strategy] Property has a value of "Direct Properties".</strong></td></tr><tr><td id="name"><strong>Vault Properties Files</strong></td><td>vault.properties.files</td><td></td><td id="allowable-values"></td><td id="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.<br/><br/><strong>This property expects a comma-separated list of file resources.</strong><br/><br/><br/><strong>This Property is only considered if </strong><strong>the [Configuration Strategy] Property has a value of "Properties Files".</strong></td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td>vault.connection.timeout</td><td id="default-value">5 sec</td><td id="allowable-values"></td><td id="description">The connection timeout for the HashiCorp Vault client</td></tr><tr><td id="name"><strong>Read Timeout</strong></td><td>vault.read.timeout</td><td id="default-value">15 sec</td><td id="allowable-values"></td><td id="description">The read timeout for the HashiCorp Vault client</td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>Yes</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A Spring Vault configuration property name</td><td id="value">The property value</td><td>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.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> |