ALM Template Language

Last updated 5 months ago
Contents

ALM Template provides several built-in functions that help you manage your ALM Template. These functions are named ATL, short for ALM Template Language. Not to be confused with Microsoft's ATL.

Use ATL functions in your templates to assign values to properties that are not available until runtime.

For now, ATL is only supported in AWS. Support for other cloud vendors will be available soon.

You can use ATL functions only in specific parts of a template. Please refer to each functions' document for detailed explanation.

computed

Usage:

${computed}

This function is used to calculate the valid value for supported declarative in your ALM Template.

Example:

"instance_type": "${computed}"

use

Usage:

${use( .. )}

This function is used to reference the value that you defined in other declarative already.

Example:

"availability_zones": "${use(Layer1.provision.availability_zone),use(Layer2.provision.availability_zone)}"

Note: This function can only be used if the origin value is type of string, it cannot be applied to any other type of values. For referencing values such as object or array, you use ${copy( .. )}.

copy

Usage:

${copy( .. )}

This function is used to copy the whole value that you defined in other declarative already.

Example:

"security_group": "${copy(Layer1.provision.security_group)}"

ref

Usage:

#ref( .. )

Currently, this function can be used only in:

  1. load_balancer : security_groups

    "load_balancer": {
    "security_groups": "#ref(Layer2.provision.security_group)",
    },

    Use case explanation:

    When the load balancer requires specified security groups, you can use this function to reference the security groups that are defined in security_group declarative.

share

Usage:

#share( .. )

Currently, this function can be used in two declarative:

  1. load_balancer : subnets

    "load_balancer": {
    "subnets": "#share(Layer1.provision.subnet,Layer2.provision.subnet)",
    },

    Use case explanation:

    When you deploy an application or networking load balancer on AWS, by default each load balancer requires at least two subnets, so you use this function to define the target subnets which will be used by this load balancer.

  2. auto_scaling

    {
    "auto_scaling": "#share(Layer1.provision.auto_scaling)"
    }

    Use case explanation:

    When you register multiple load balancers to the instances that are in the same auto scaling group, you use this function to define the target auto scaling group which will be shared with this load balancer.