FarmRoleTemplate object

Example JSON representation

{
  "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
advancedConfiguration FarmRoleAdvancedConfiguration object	optional		Advanced Farm Role configuration.
alias string	optional		The Alias for this Farm Role.
availabilityZones Array of string	optional		The list of availability zones. This property is available only for GCE, Openstack, Azure and AWS based Farm Roles. Please note, that the value is required for GCE Farm Roles, but for Openstack and AWS the availability zone will be chosen by the cloud engine if property is empty or not specified.
bootstrapping BootstrapConfiguration object	optional		Farm Role bootstrap configuration. Please note this property is available only for Farm Roles configured with enabled Chef built-in automation.
cloudFeatures CloudFeatures object	optional		Cloud specifics Farm Role configuration. This property is available only for Azure and AWS based Farm Roles. Please note, that the value is required for AzureConfiguration.
cloudLocation string	create-only		The Cloud Location.
cloudPlatform string	create-only	"ec2" "gce" "azure" "cloudstack" "idcf" "openstack" "ocs" "otc" "rackspacenguk" "rackspacengus" "hpcloud" "mirantis" "vio" "cisco" "vmware"	The Cloud Platform this Farm Role runs on.
instanceType InstanceTypeForeignKey object	optional		The instance type that should be used for all instances related to this Farm Role.
launchIndex integer	optional		Launch index for this Farm Role.
networking NetworkConfigurationTemplate object	optional		Farm Role network configuration. Please note that this property is not available for AWS Farm Roles that weren't launched inside Amazon VPC.
orchestration OrchestrationTemplateContent object	optional		Farm Role orchestration configuration.
role RoleIdentityTemplateContent object	optional		Identifier of the Role.
scaling ScalingTemplateContent object	optional
security SecurityConfiguration object	optional
storage Array of StorageConfiguration objects	optional		Storage configuration
variables Array of GlobalVariable objects	optional		Farm Role Global Variables.