cfngen

Documentation

Overview

Package cfngen generates CloudFormation from Go objects.

Index

• func SanitizeResourceName(name string) string
• type Output
• type Parameter
• type Ref
• type Sub
• type Template
  • func NewTemplate(description string, parameters map[string]interface{}, ...) (t *Template)
  • func (t *Template) CloudFormation() ([]byte, error)
  • func (t *Template) WriteCloudFormation(w io.Writer) (err error)

Functions

func SanitizeResourceName

func SanitizeResourceName(name string) string

Types

type Output

type Output struct {
	Description string
	Value       interface{}
}

type Parameter

type Parameter struct {
	Type          string
	Default       interface{}   `json:",omitempty"`
	Description   string        `json:",omitempty"`
	AllowedValues []interface{} `json:",omitempty"`
	MinValue      interface{}   `json:",omitempty"`
	MaxValue      interface{}   `json:",omitempty"`
}

Represents CF Parameter

type Ref

type Ref struct {
	Ref string
}

Represents a CF reference

type Sub

type Sub struct {
	Sub string `json:"Fn::Sub"`
}

Represents a simple CF Fn::Sub using template params

type Template

type Template struct {
	AWSTemplateFormatVersion string
	Description              string                 `json:",omitempty"`
	Parameters               map[string]interface{} `json:",omitempty"`
	Resources                map[string]interface{} `json:",omitempty"`
	Outputs                  map[string]interface{} `json:",omitempty"`
}

Represents a CF template

func NewTemplate

func NewTemplate(description string, parameters map[string]interface{}, resources map[string]interface{},
	outputs map[string]interface{}) (t *Template)

Create a CF template , use WriteCloudFormation() to emit.

func (*Template) CloudFormation

func (t *Template) CloudFormation() ([]byte, error)

Emit CF as JSON return []bytes

func (*Template) WriteCloudFormation

func (t *Template) WriteCloudFormation(w io.Writer) (err error)

Emit CF as JSON to io.Writer