Base Schemas are never configured by themselves, they are schemas that are inherited by other schemas.
A generic placeholder for any schema.
A name given to a cloud resource. Names identify resources and changing them can break configuration.
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| name | String | Name |
Base Schemas Title
A title is a human-readable name. It can be as long as you want, and can change without breaking any configuration.
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| title | String | Title |
A name that can be changed or duplicated with other similar cloud resources without breaking anything.
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| name | String | Name |
Configuration for a cloud resource. Resources may represent a single physical resource in the cloud, or several closely related resources.
| 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
Indicates if this configuration tree should be enabled or not.
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| enabled | Boolean | Enabled | Could be deployed to AWS | False |
Indicate if this configuration should be enabled.
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| enabled | Boolean | Enabled | True |
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| type | String | Type of Resources | A valid AWS Resource type: ASG, LBApplication, etc. |
Provides a parent with an inheritable DNS enabled field
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| dns_enabled | Boolean | Boolean indicating whether DNS record sets will be created. | True |
A monitorable resource
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| monitoring | Object<MonitorConfig> |
A set of metrics and a default collection interval
| 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
Container for objects which do not belong to a specific Environment.
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| alarm_sets | Container<AlarmSets> | Alarm Sets |
An Account and one or more Regions
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| account | PacoReference |star| | AWS Account | Paco Reference to Account. | |
| regions | List<String> |star| | Regions |
A notifiable object
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| notifications | Container<AlarmNotifications> | Alarm Notifications |
| 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
Application Engine : A template describing an application
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| groups | Container<ResourceGroups> |star| | |||
| order | Int | The order in which the application will be processed | 0 |
Base Schemas DNSEnablable, Deployable, Monitorable, Named, Notifiable, Title
| Field name | Type | Purpose | Constraints | Default |
|---|---|---|---|---|
| security_groups | List<PacoReference> | List of VPC Security Group Ids | Paco Reference to SecurityGroup. | |
| segments | List<PacoReference> | VPC Segments to attach the function | Paco Reference to Segment. |
- Base interface for IRoute53HostedZone and IPrivateHostedZone
A callable function that returns a value.