OrchestrationRule object

Example JSON representation

{
  "action": {
    "actionType": "Action"
  }, 
  "blocking": true, 
  "enabled": true, 
  "id": "string", 
  "order": 1, 
  "runAs": "string", 
  "scope": "scalr", 
  "target": {
    "targetType": "Target"
  }, 
  "timeout": 1, 
  "trigger": {
    "triggerType": "Trigger"
  }
}

Properties

property attributes valid values description filter option
action
Action object
required

Orchestration Rule action that will be executed on the target servers.

target
Target object
required

The set of Servers where the Orchestration Rules Action will be executed.

trigger
Trigger object
required

Orchestration Rule trigger.

id
string
read-only
filterable

Unique identifier for an Orchestration Rule.

?id=...
scope
string
read-only
"scalr"
"account"
"environment"
"farm"
"farmrole"
"role"
"server"
blocking
boolean
optional
filterable

Whether this Orchestration Rule's execution should delay the execution of further Orchestration Rules and the triggering of further Events. Defaults to the action's default when null.

?blocking=...
enabled
boolean
optional

If Orchestration Rule is not enabled this Rule won't be triggered

order
integer
optional
filterable

The priority of this Orchestration Rule relative to other Orchestration Rules that use the same triggeringEvent. Default is relative to existing Rules.

?order=...
runAs
string
optional
filterable

A name of the system user the Orchestration Rule should be executed as. Administrator / root is used by default.

?runAs=...
timeout
integer
optional

The time Scalr should wait for before aborting the execution of this Orchestration Rule, in seconds. Defaults to the action's default when null.

Endpoints using this object