Skip to main content

Type Alias: FunctionSettings

type FunctionSettings: components["schemas"]["FunctionSettings"];

Properties

PropertyTypeRequiredDescription
isActivatedbooleanYesWhether Functions feature is activated
activationStep"pending" | "registry" | "image" | "config" | "deployment" | "server" | "complete" | "error"NoCurrent activation step (for async progress tracking)
activationErrorstringNoError message if activation failed
fleetAppIdnumberNoFleet app ID
fleetRegistryIdnumberNoFleet Docker registry ID
fleetImageIdstringNoFleet binary/image ID
fleetServerConfigIdstringNoFleet server config ID
fleetDeploymentIdnumberNoFleet deployment ID (app location setting)
resourcePackageSlugstringNoResource package slug (example: "fleet-s1")
locationCitystringNoDeployment location city (example: "frankfurt")
fleetRegionstringNoFleet region (deprecated, use locationCity) (example: "eu-west")
maxFunctionsnumberYesMaximum functions allowed (example: 10)
maxMemoryPerFunctionnumberYesMaximum memory per function (MB) (example: 512)
dependenciesFunctionDependency[]NoNPM dependencies shared by all functions
envVarsFunctionEnvVar[]NoEnvironment variables shared by all functions (secrets masked)

Defined in

4Players/cortex-typescript-sdk/src/resources/functions.ts:10