cfn

Documentation

Overview

Package cfn provides the Template type that models a CloudFormation template.

The sub-packages of cfn contain various tools for working with templates

Index

• type Element
• type Error
• type Template
  • func (t Template) Check() (value.Interface, bool)
  • func (t Template) Diff(other Template) diff.Diff
  • func (t Template) Graph() graph.Graph
  • func (t Template) Map() map[string]interface{}

Types

type Element

type Element struct {
	// Name is the name of the element
	Name string

	// Type is the name of the top-level part of a CloudFormation
	// that contains this Element (e.g. Resources, Parameters)
	Type string
}

Element represents a top-level entry in a CloudFormation template for example a resource, parameter, or output

type Error

type Error struct {
	// contains filtered or unexported fields
}

Error holds errors messages pertaining to a cfn.Template

type Template

type Template map[string]interface{}

Template represents a CloudFormation template. The Template type is minimal for now but will likely grow new features as needed by rain.

func (Template) Check

func (t Template) Check() (value.Interface, bool)

Check validates a cfn.Template against the cloudformation spec

func (Template) Diff

func (t Template) Diff(other Template) diff.Diff

Diff returns a Diff object representing the difference between this template and the template passed to Diff

func (Template) Graph

func (t Template) Graph() graph.Graph

Graph returns a Graph representing the connections between elements in the template. The type of each item in the graph should be Element

func (Template) Map

func (t Template) Map() map[string]interface{}

Map returns the template as a map[string]interface{} This can be used for easy serialisation to e.g. JSON or YAML