specification

Documentation

Overview

Package specification privides tools for downloading and parsing AWS CloudFormation Resource Specification.

Index

• type Attribute
• type Property
  • func (property *Property) IsSubproperty() bool
• type PropertyType
• type Resource
• type Specification
  • func GetSpecification(context *context.Context) (specification Specification, err error)
  • func GetSpecificationFromFile(specificationFilePath string) (specification Specification, err error)

Types

type Attribute

type Attribute struct {
	ItemType          string
	PrimitiveItemType string
	PrimitiveType     string
	Type              string
}

Attribute of item.

type Property

type Property struct {
	Documentation     string
	DuplicatesAllowed bool
	ItemType          string
	PrimitiveItemType string
	PrimitiveType     string
	Required          bool
	Type              string
	UpdateType        string
}

Property describes what should be in structure.

func (*Property) IsSubproperty

func (property *Property) IsSubproperty() bool

IsSubproperty : Checks if it is subproperty.

type PropertyType

type PropertyType struct {
	Documentation string
	Properties    map[string]Property
}

PropertyType contains Documentation and map of Properties.

type Resource

type Resource struct {
	Documentation string
	Attributes    map[string]Attribute
	Properties    map[string]Property
}

Resource in specification contains documentation, map of attributes and properties.

type Specification

type Specification struct {
	PropertyTypes                map[string]PropertyType
	ResourceSpecificationVersion string
	ResourceTypes                map[string]Resource
}

Specification contains information about specification - type and version.

func GetSpecification

func GetSpecification(context *context.Context) (specification Specification, err error)

Download specification for region specified in config.

func GetSpecificationFromFile

func GetSpecificationFromFile(specificationFilePath string) (specification Specification, err error)

Get specification from file. It's used in GetSpecification().