SoftwareRecipe class

A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is UPDATED, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step.

Constructors

SoftwareRecipe({Input<List<SoftwareRecipeArtifact>>? artifacts, Input<SoftwareRecipeDesiredState>? desiredState, Input<List<SoftwareRecipeStep>>? installSteps, required Input<String> name, Input<List<SoftwareRecipeStep>>? updateSteps, Input<String>? version})
Creates a new SoftwareRecipe. artifacts Resources available to be used in the steps in the recipe. desiredState Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. installSteps Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. name Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments. updateSteps Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. version The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).
const
SoftwareRecipe.fromMap(Map<String, dynamic> map)
factory

Properties

artifacts → Input<List<SoftwareRecipeArtifact>>?
Resources available to be used in the steps in the recipe.
final
desiredState → Input<SoftwareRecipeDesiredState>?
Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.
final
hashCode → int
The hash code for this object.
no setterinherited
installSteps → Input<List<SoftwareRecipeStep>>?
Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
final
name → Input<String>
Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
updateSteps → Input<List<SoftwareRecipeStep>>?
Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
final
version → Input<String>?
The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited