GlobalVariableString object

Polymorphism

GlobalVariableString is a type that implements the GlobalVariable type.

When an object of type GlobalVariable is expected, you can use one of type GlobalVariableString (or use any other implementation).

Example JSON representation

{
  "category": "string", 
  "computedCategory": "string", 
  "computedValue": "string", 
  "declaredIn": "scalr", 
  "definedIn": "scalr", 
  "description": "string", 
  "hidden": true, 
  "locked": true, 
  "name": "string", 
  "outputFormat": "string", 
  "requiredIn": "scalr", 
  "type": "GlobalVariableString", 
  "validationPattern": "string", 
  "value": "string"
}

Properties

property attributes valid values description filter option
name
string
required
create-only
type
string
required
"GlobalVariableString"

The type of Global Variable.

computedCategory
string
read-only

The category computed by Scalr for this Global Variable.

computedValue
string
read-only

The value computed by Scalr for this Global Variable.

declaredIn
string
read-only
"scalr"
"account"
"environment"
"farm"
"farmrole"
"role"
"server"

The Scope in which this Global Variable is declared.

definedIn
string
read-only
"scalr"
"account"
"environment"
"farm"
"farmrole"
"role"
"server"

The Scope in which this Global Variable is given a value.

category
string
optional

The category of this Global Variable.

description
string
optional

A description that explains what this Global Variable is used for.

hidden
boolean
optional

Whether this Global Variable is hidden in inner scopes. This is read-only if declaredIn is not the current scope.

locked
boolean
optional

Whether this Global Variable is locked in inner scopes. This is read-only if declaredIn is not the current scope.

outputFormat
string
optional

The formatting to apply when displaying this variable. This is read-only if declaredIn is not the current scope.

requiredIn
string
optional
"scalr"
"account"
"environment"
"farm"
"farmrole"
"role"
"server"

The scope where this Global Variable is required. This is read-only if declaredIn is not the current scope.

validationPattern
string
optional
value
string
optional

The value declared in the current scope for this Global Variable. If it is null, the value will be inherited from higher scopes. This field is ignored if declaredIn is not the current scope.