CostFormation Language Reference

Conditions

This sections lists the supported conditions.

And

This condition evaluates a list of conditions as a logical And operation.

  - And:
    - <Condition 1>
    - <Condition 2>
    ...
    - <Condition N>

This condition evaluates to True only if all conditions evaluate to True. If a single condition in the list evaluates to False, then the entire condition evaluates to False.

BeginsWith

This condition checks whether the source value begins with the any of the specified strings. This condition can optionally specify its own source properties.

  - BeginsWith: <Value>
    <Source Properties>

Or

  - BeginsWith:
      - <Value 1>
      - <Value 2>
      ...
      - <Value N>
    <Source Properties>

Contains

This condition checks whether the source value contains any of the specified strings. This condition can optionally specify its own source properties.

  - Contains: <Value>
    <Source Properties>

Or

  - Contains:
      - <Value 1>
      - <Value 2>
      ...
      - <Value N>
    <Source Properties>

Equals

This condition checks whether the source value equals any of the specified strings. This condition can optionally specify its own source properties.

  - Equals: <Value>
    <Source Properties>

Or

  - Equals:
      - <Value 1>
      - <Value 2>
      ...
      - <Value N>
    <Source Properties>

HasValue

This condition checks whether the source value has an actual value or not. This condition can optionally specify its own source properties.

  - HasValue: <True|False>
    <Source Properties>

If HasValue is set to True, then the condition evaluates to True if the source has a value. If HasValue is False, then the condition evaluates to False if the source does not have a value.

Not

This condition evaluates the list of conditions as a logical Or and then negates the result.

  - Not:
    - <Condition 1>
    - <Condition 2>
    ...
    - <Condition N>

This condition evaluates to True only if all conditions evaluate to False. If a single condition in the list evaluates to True, then the entire condition evaluates to False.

Or

This condition evaluates the list of conditions as a logical Or.

  - Or:
    - <Condition 1>
    - <Condition 2>
    ...
    - <Condition N>

This condition evaluates to True if any of the list of conditions evaluate to True. If all conditions in the list evaluate to False, then the entire condition evaluates to False.

Sources

This section describe the available sources that can be referenced when building Custom Dimensions with CostFormation. The sources are broken down by types of sources (i.e. sources direct from billing data, resource tags, etc). Each table shows the Source ID which is the ID of the source that would be used in the Custom Dimension definition.

📘

Dimensions in the Explorer and Views

Not all source dimensions listed in this section are available in the Explorer or Views and some are located with a slightly different name than their ID. Check the Name in Explorer/Views column to see which source IDs are visible in the Explorer and Views and under which name.

Core Cloud Provider Dimensions

These dimensions are sourced directly from billing data from your cloud provider.

Additional Cloud Provider Dimensions

The following dimensions are defined by CloudZero, based on billing data from your cloud provider. They are available in the Explorer and Views.

📘

Best Practices for Sourcing Resource Dimensions

CloudZero supports multiple types of dimensions related to resources and resource IDs:

• Resource uses CZRN identifiers. Example: czrn:aws:ec2:us-east-2:123456789012:instance:i-056061216d0a1b2c3
• CZ:Defined:ResourceDisplay uses native resource IDs. Example: i-056061216d0a1b2c3
• CZ:Defined:ResourceSummaryID uses CZRN for summarized resources. Example: czrn:aws:ec2:us-east-2:123456789012:instances
• CZ:Defined:ResourceSummaryDisplay uses native IDs for summarized resources. Example: ec2-instance

If you are writing CostFormation to match against resources, CZ:Defined:ResourceSummaryDisplay is almost always the best choice. This dimension uses the native resource IDs shown in the CloudZero UI, and it improves Explorer performance by grouping logically related resources together instead of enumerating individual instance IDs.

Tag Dimensions

The CloudZero platform inspects all of your cloud resources and compiles the list of tags, both AWS tags and user tags, and exposes them as Dimensions that can be used throughout the platform. All tags are available in the Explorer and Views.

Kubernetes Dimensions

Some dimensions are derived from dynamic data that is discovered through Kubernetes integrations. All Kubernetes dimensions are available in the Explorer and Views.

Custom Dimensions

All Custom Dimensions are available in the Explorer and Views.

Transforms

Lower

This transform will lowercase all of the letters in the source value. This transform has no parameters.

  - Type: Lower

Example:

Normalize

This transform will lowercase all of the letters in a the source value and will also convert any instance of the characters .,/#!$%^&*;:=_ ~()\' to a dash (-). This transform has no parameters.

  - Type: Normalize

Example:

Split

This transform will split the source value into a list of substrings using a specified delimiter. It will then extract the substring based on the specified index. The index is 1 based.

  - Type: Split
    Delimiter: <delimiter>
    Index: <1 based index>

Example: