cfn

package

v0.7.2 Latest Latest Go to latest Published: Nov 13, 2019 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aws-cloudformation/rain

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 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) 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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
diff Package diff provides the Diff class that can be used to compare CloudFormation templates	Package diff provides the Diff class that can be used to compare CloudFormation templates
format Package format provides functions for formatting the types found in the cfn package.	Package format provides functions for formatting the types found in the cfn package.
graph Package graph provides an implement of cfn.Graph and can be used to graph dependencies between elements of a CloudFormation template	Package graph provides an implement of cfn.Graph and can be used to graph dependencies between elements of a CloudFormation template
parse Package parse provides functions for parsing CloudFormation templates from JSON and YAML inputs.	Package parse provides functions for parsing CloudFormation templates from JSON and YAML inputs.
value Package value provides a Value type that can be used to contain structured data of any type and comments that reference elements within it.	Package value provides a Value type that can be used to contain structured data of any type and comments that reference elements within it.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL