blob: 5405abe5efa35b0905b1dca59e21766dd1aa34a4 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EnvironmentVariableParameterProvider</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;">EnvironmentVariableParameterProvider</h1><h2>Description: </h2><p>Fetches parameters from environment variables</p><h3>Tags: </h3><p>environment, variable</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.</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>Parameter Group Name</strong></td><td>parameter-group-name</td><td id="default-value">Environment Variables</td><td id="allowable-values"></td><td id="description">The name of the parameter group that will be fetched. This indicates the name of the Parameter Context that may receive the fetched parameters.</td></tr><tr><td id="name"><strong>Environment Variable Inclusion Strategy</strong></td><td>environment-variable-inclusion-strategy</td><td id="default-value">Include All</td><td id="allowable-values"><ul><li>Include All <img src="../../../../../html/images/iconInfo.png" alt="All Environment Variables will be included" title="All Environment Variables will be included"></img></li><li>Comma-Separated <img src="../../../../../html/images/iconInfo.png" alt="List comma-separated Environment Variable names to include" title="List comma-separated Environment Variable names to include"></img></li><li>Regular Expression <img src="../../../../../html/images/iconInfo.png" alt="Include Environment Variable names that match a Regular Expression" title="Include Environment Variable names that match a Regular Expression"></img></li></ul></td><td id="description">Indicates how Environment Variables should be included</td></tr><tr><td id="name">Include Environment Variables</td><td>include-environment-variables</td><td></td><td id="allowable-values"></td><td id="description">Specifies environment variable names that should be included from the fetched environment variables.<br/><br/><strong>This Property is only considered if </strong><strong>the [Environment Variable Inclusion Strategy] Property is set to one of the following values: [Regular Expression], [Comma-Separated]</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>access environment credentials</td><td>Provides operator the ability to read environment variables, which may contain environment credentials.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html>