YAML File Schemas

Base Schemas

Base Schemas are never configured by themselves, they are schemas that are inherited by other schemas.

Interface

A generic placeholder for any schema.

Named

A name given to a cloud resource. Names identify resources and changing them can break configuration.

Named
Field name Type Purpose Constraints Default
name String Name    

Base Schemas Title

Title

A title is a human-readable name. It can be as long as you want, and can change without breaking any configuration.

Title
Field name Type Purpose Constraints Default
title String Title    

Name

A name that can be changed or duplicated with other similar cloud resources without breaking anything.

Name
Field name Type Purpose Constraints Default
name String Name    

Resource

Configuration for a cloud resource. Resources may represent a single physical resource in the cloud, or several closely related resources.

Resource
Field name Type Purpose Constraints Default
change_protected Boolean Boolean indicating whether this resource can be modified or not.   False
order Int The order in which the resource will be deployed   0

Base Schemas DNSEnablable, Deployable, Named, Title, Type

Deployable

Indicates if this configuration tree should be enabled or not.

Deployable
Field name Type Purpose Constraints Default
enabled Boolean Enabled Could be deployed to AWS False

Enablable

Indicate if this configuration should be enabled.

Enablable
Field name Type Purpose Constraints Default
enabled Boolean Enabled   True

Type

Type
Field name Type Purpose Constraints Default
type String Type of Resources A valid AWS Resource type: ASG, LBApplication, etc.  

DNSEnablable

Provides a parent with an inheritable DNS enabled field

DNSEnablable
Field name Type Purpose Constraints Default
dns_enabled Boolean Boolean indicating whether DNS record sets will be created.   True

Monitorable

A monitorable resource

Monitorable
Field name Type Purpose Constraints Default
monitoring Object<MonitorConfig>      

MonitorConfig

A set of metrics and a default collection interval

MonitorConfig
Field name Type Purpose Constraints Default
alarm_sets Container<AlarmSets> Sets of Alarm Sets    
asg_metrics List<String> ASG Metrics Must be one of: ‘GroupMinSize’, ‘GroupMaxSize’, ‘GroupDesiredCapacity’, ‘GroupInServiceInstances’, ‘GroupPendingInstances’, ‘GroupStandbyInstances’, ‘GroupTerminatingInstances’, ‘GroupTotalInstances’  
collection_interval Int Collection interval   60
health_checks Container<HealthChecks> Set of Health Checks    
log_sets Container<CloudWatchLogSets> Sets of Log Sets    
metrics List<Metric> Metrics    

Base Schemas Deployable, Named, Notifiable, Title

RegionContainer

Container for objects which do not belong to a specific Environment.

RegionContainer
Field name Type Purpose Constraints Default
alarm_sets Container<AlarmSets> Alarm Sets    

Base Schemas Named, Title

Notifiable

A notifiable object

Notifiable
Field name Type Purpose Constraints Default
notifications Container<AlarmNotifications> Alarm Notifications    

SecurityGroupRule

SecurityGroupRule
Field name Type Purpose Constraints Default
cidr_ip String CIDR IP A valid CIDR v4 block or an empty string  
cidr_ip_v6 String CIDR IP v6 A valid CIDR v6 block or an empty string  
description String Description Max 255 characters. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*.  
from_port Int From port A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. -1
port Int Port A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. -1
protocol String IP Protocol The IP protocol name (tcp, udp, icmp, icmpv6) or number.  
to_port Int To port A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. -1

Base Schemas Name

ApplicationEngine

Application Engine : A template describing an application

ApplicationEngine
Field name Type Purpose Constraints Default
groups Container<ResourceGroups>      
order Int The order in which the application will be processed   0

Base Schemas DNSEnablable, Deployable, Monitorable, Named, Notifiable, Title

Function

A callable function that returns a value.