AWS User Data Variables
This topic provides a list of variables supported in AWS user data. For general information on variables, see Adding Commander Metadata to Workflows With Variables.
If you need a variable that isn't documented, contact support@snowsoftware.com, and if the variable is available, we'll provide you with the variable name. We'll also add it to the list of documented variables in the next release.
| Variable | Expression | Description |
|---|---|---|
| Commander | ||
| Directory | system.directory | Directory where Commander is installed. |
| IP Address | system.address | The IP address for the Commander server. |
| Port | system.port | The port number used by Commander. |
| Infrastructure | ||
| Region | target.region.name | The component's region. |
| Request | ||
| Request ID | request.id | The unique identifier for the service request. |
| Requested Component | ||
| Chef Environment | target.settings.chef.environment | The Chef environment set in the service catalog. |
| Chef Organization | target.settings.chef.organization | The Chef organization set in the service catalog. |
| Chef Recipes | target.settings.chef.recipes | A comma-separated list of Chef recipes. Includes the default values set in the service catalog and those specified by the user on the request form. |
| Chef Roles | target.settings.chef.roles | A comma-separated list of Chef roles. Includes the default values set in the service catalog and those specified by the user on the request form. |
| Chef Run-List | target.settings.chef.runlist | A comma-separated list of Chef roles and Chef recipes in the order specified in the Run-List. Includes the default values set in the service catalog and those specified by the user on the request form. |
| Component Name | target.settings.componentName | The name for the VM as specified by the user on the request form. |
| CPUs | target.settings.cpuCount | The number of CPUs, if changed. For change requests, a value of -1 indicates that the value is the same as set on the source service. |
| Dynamic List | target.settings.dynamicList['*'] | The value of the specified dynamic list from the request. Replace * with the name of the dynamic list. |
| Input Field | target.settings.inputField['*'] | The value of the specified input text field from the request. Replace * with the name of the input text field. |
| Instance Type Remote ID | target.settings.instanceType.remoteId | The instance type ID (for example, t1.micro, m3.2xlarge). |
| Key Pair | target.settings.keyPair.name | The name of the requested key pair. |
| Memory | target.settings.memory.gb | Memory of the VM, if changed, in gigabytes. For change requests, a value of -1 indicates that the value is the same as that set in the service catalog (or on the source template, for legacy component forms). |
| Network Adapters | target.settings.nicCount | The number of network adapters requested. |
| Puppet Classes | target.settings.puppet.classes | A comma-separated list of Puppet classes. Includes the default values set in the service catalog and those specified by the user on the request form. |
| Puppet Environment | target.settings.puppet.environment | The Puppet environment set in the service catalog. |
| Puppet Groups | target.settings.puppet.groups | A comma-separated list of Puppet groups. Includes the default values set in the service catalog and those specified by the user on the request form. |
| Total Storage | target.settings.storage.gb | For new requests, the total of all storage, in GB. For change requests, this value represents existing storage plus any changes. |
| Uploaded File | target.settings.uploadedFile['*'] | The name(s) of the specified uploaded file(s) from the request. Replace * with the display label of the File Upload control. |
| Uploaded File Content | target.settings.uploadedFile['*'].file[x].content | The content of the file for an File Upload control in the request. Replace * with the name of the File Upload control. Replace [x] with a number starting with [1]; for example, [2] represents the second file in the File Upload control. |
| Uploaded File Name | target.settings.uploadedFile['*'].file[x].fileName | The filename for an File Upload control in the request. Replace * with the name of the File Upload control. Replace [x] with a number starting with [1]; for example, [2] represents the second file in the File Upload control. |
| Requested Component Custom Attributes | ||
| Custom Attribute | target.settings.customAttribute['*'] | The value of the specified custom attribute from the request. Replace * with the name of the custom attribute. |
| Requester | ||
| Organization Name | request.requester.organization.name | The organization of the user requesting the VM. |
| Requester UserId | request.requester.userId | The user ID of the requesting user. |
| Target | ||
| Deployed Name | target.deployedName | The deployed name of the component. |