parse

package

v0.8.0 Latest Latest Go to latest Published: Jan 22, 2020 License: Apache-2.0 Imports: 11 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 parse provides functions for parsing CloudFormation templates from JSON and YAML inputs.

Example ¶

package main

import (
	"fmt"

	"github.com/aws-cloudformation/rain/cfn/parse"
)

func main() {
	template, _ := parse.String(`
Resources:
  Bucket:
    Type: AWS::S3::Bucket
`)

	fmt.Println(template.Map())
}

Output:

map[Resources:map[Bucket:map[Type:AWS::S3::Bucket]]]

Index ¶

func File(fileName string) (cfn.Template, error)
func Map(input map[string]interface{}) (cfn.Template, error)
func Reader(r io.Reader) (cfn.Template, error)
func String(input string) (cfn.Template, error)
func Verify(source cfn.Template, output string) error

Examples ¶

Package

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func File ¶

func File(fileName string) (cfn.Template, error)

Reader returns a cfn.Template parsed from a file specified by fileName

func Map ¶

func Map(input map[string]interface{}) (cfn.Template, error)

func Reader ¶

func Reader(r io.Reader) (cfn.Template, error)

Reader returns a cfn.Template parsed from an io.Reader

func String ¶

func String(input string) (cfn.Template, error)

Reader returns a cfn.Template parsed from a string

func Verify ¶

func Verify(source cfn.Template, output string) error

Verify confirms that there is no semantic difference between the source cfn.Template and the string representation in output. This can be used to ensure that the parse package hasn't done anything unexpected to your template.

Types ¶

This section is empty.

Source Files ¶

View all Source files

parse.go

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