GlobalVariable object

Abstract Type

GlobalVariable is an abstract type. When an object of type GlobalVariable is expected, you must pass an object of one of the following types:

property	attributes	valid values	description
name string	required create-only
type string	required	"GlobalVariableJson" "GlobalVariableString" "GlobalVariableList" "GlobalVariableRemoteList"	The type of 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.
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.
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.