FarmTemplate object

Example JSON representation

{
  "_meta": {
    "schema_version": "string"
  },
  "farm": {
    "description": "string",
    "launchOrder": "simultaneous",
    "lightsOut": {
      "autostart": true,
      "enabled": true,
      "notifications": [
        {
          "minutes": 1,
          "type": "LightsOutNotification"
        }
      ],
      "schedule": [
        {
          "daysOfWeek": [
            "sun"
          ],
          "end": "2013-01-01T12:34:56.789Z",
          "start": "2013-01-01T12:34:56.789Z"
        }
      ],
      "shutdownBehavior": "terminate"
    },
    "locked": {
      "comment": "string",
      "unlockPermission": "owner"
    },
    "name": "string",
    "owner": {
      "email": "string",
      "id": 1
    },
    "project": {
      "id": "string"
    },
    "teams": [
      {
        "id": 1,
        "name": "string"
      }
    ],
    "timezone": "string",
    "variables": [
      {
        "category": "string",
        "computedValue": "string",
        "declaredIn": "scalr",
        "definedIn": "scalr",
        "description": "string",
        "hidden": true,
        "locked": true,
        "name": "string",
        "requiredIn": "scalr",
        "type": "GlobalVariable",
        "value": "string"
      }
    ]
  },
  "roles": [
    {
      "advancedConfiguration": {
        "abortInitializationOnOrchestrationFailure": true,
        "disableAgentHostnameManagement": true,
        "disableAgentIptablesManagement": true,
        "disableAgentNtpManagement": true,
        "instanceName": "string",
        "rebootAfterHostInit": true
      },
      "alias": "string",
      "availabilityZones": [
        "string"
      ],
      "bootstrapping": {
        "enabled": true,
        "type": "BootstrapConfiguration"
      },
      "cloudFeatures": {
        "type": "CloudFeatures"
      },
      "cloudLocation": "string",
      "cloudPlatform": "ec2",
      "instanceType": {
        "id": "string"
      },
      "launchIndex": 1,
      "networking": {
        "hostname": {
          "domainName": "string",
          "type": "HostnameConfiguration"
        },
        "networks": [
          {
            "associatePublicIpAddress": true,
            "cloudFeatures": {
              "type": "NetworkCloudFeatures"
            },
            "id": "string",
            "ipPool": {
              "id": "string"
            },
            "primary": true,
            "subnets": [
              {
                "id": "string"
              }
            ]
          }
        ],
        "subnets": [
          {
            "id": "string",
            "networkId": "string"
          }
        ]
      },
      "orchestration": {
        "rules": [
          {
            "action": {
              "actionType": "Action"
            },
            "blocking": true,
            "enabled": true,
            "order": 1,
            "runAs": "string",
            "target": {
              "targetType": "Target"
            },
            "timeout": 1,
            "trigger": {
              "triggerType": "Trigger"
            }
          }
        ]
      },
      "role": {
        "id": 1,
        "name": "string"
      },
      "scaling": {
        "considerSuspendedServers": "running",
        "enabled": true,
        "maxInstances": 1,
        "minInstances": 1,
        "rules": [
          {
            "name": "string",
            "ruleType": "ScalingRule"
          }
        ],
        "scalingBehavior": "suspend-resume"
      },
      "security": {
        "securityGroups": [
          {
            "id": "string",
            "name": "string"
          }
        ]
      },
      "storage": [
        {
          "id": "string",
          "type": "StorageConfiguration"
        }
      ],
      "variables": [
        {
          "category": "string",
          "computedValue": "string",
          "declaredIn": "scalr",
          "definedIn": "scalr",
          "description": "string",
          "hidden": true,
          "locked": true,
          "name": "string",
          "requiredIn": "scalr",
          "type": "GlobalVariable",
          "value": "string"
        }
      ]
    }
  ]
}

Properties

property attributes valid values description filter option
_meta
TemplateMetadata object
optional
farm
FarmTemplateContent object
optional

Farm properties.

roles
Array of FarmRoleTemplate objects
optional

Farm Role properties that belong to the current Farm.