format

Documentation

Overview

Package format contains functionality to render a cft.Template into YAML or JSON

Index

• Constants
• Variables
• func CftToPkl(t cft.Template, basic bool, pklPackageAlias string) (string, error)
• func CftToYaml(t cft.Template) string
• func CheckMultilineBegin(s string) bool
• func Jsonise(node *yaml.Node) interface{}
• func PrettyPrint(i interface{}) string
• func String(t cft.Template, opt Options) string
• func ToJson(i interface{}, indent string) ([]byte, error)
• type MapItem
  • func (mi MapItem) String() string
  • func (mi *MapItem) UnmarshalJSON(b []byte) error
• type MapSlice
  • func (ms MapSlice) Len() int
  • func (ms MapSlice) Less(i, j int) bool
  • func (ms MapSlice) MarshalJSON() ([]byte, error)
  • func (ms MapSlice) Swap(i, j int)
  • func (ms *MapSlice) UnmarshalJSON(b []byte) error
• type Options

Constants

const (
	SUB       = "Fn::Sub"
	REF       = "Ref"
	GETATT    = "Fn::GetAtt"
	EQUALS    = "Fn::Equals"
	CONTAINS  = "Fn::Contains"
	FINDINMAP = "Fn::FindInMap"
	GETAZS    = "Fn::GetAZs"
	SELECT    = "Fn::Select"
)

Variables

var NodeStyle string

Global, set by command arg --node-style

var NodeStyleDocs = "Set the node output style to tagged, doublequoted, singlequoted, literal, folded, quotescalars, original, or flow"

Functions

func CftToPkl

func CftToPkl(t cft.Template, basic bool, pklPackageAlias string) (string, error)

CftToPkl serializes the template as pkl. It assumes that the user is import the cloudformation package

func CftToYaml

func CftToYaml(t cft.Template) string

CftToYaml converts a template to a YAML string

func CheckMultilineBegin

func CheckMultilineBegin(s string) bool

func Jsonise

func Jsonise(node *yaml.Node) interface{}

func PrettyPrint

func PrettyPrint(i interface{}) string

converts struct to a JSON formatted string

func String

func String(t cft.Template, opt Options) string

String returns a string representation of the supplied cft.Template

func ToJson

func ToJson(i interface{}, indent string) ([]byte, error)

ToJson overrides the default behavior of json.Marshal to leave < > alone

Types

type MapItem

type MapItem struct {
	Key, Value interface{}
	// contains filtered or unexported fields
}

MapItem representation of one map item.

func (MapItem) String

func (mi MapItem) String() string

MapItem as a string.

func (*MapItem) UnmarshalJSON

func (mi *MapItem) UnmarshalJSON(b []byte) error

UnmarshalJSON for map item.

type MapSlice

type MapSlice []MapItem

MapSlice of map items.

func (MapSlice) Len

func (ms MapSlice) Len() int

func (MapSlice) Less

func (ms MapSlice) Less(i, j int) bool

func (MapSlice) MarshalJSON

func (ms MapSlice) MarshalJSON() ([]byte, error)

MarshalJSON for map slice.

func (MapSlice) Swap

func (ms MapSlice) Swap(i, j int)

func (*MapSlice) UnmarshalJSON

func (ms *MapSlice) UnmarshalJSON(b []byte) error

UnmarshalJSON for map slice.

type Options

type Options struct {
	// JSON determines whether the outputs will be JSON (true) or YAML (false)
	JSON bool

	// Unsorted will cause the formatter to leave the ordering of template elements
	// as in the original template if true.
	// If false, the formatter will rearrange the template elements into
	// canonical order.
	Unsorted bool
}

Options contains options for formatting cfn templates