ccapi

Documentation

Index

• func CreatePatch(props *yaml.Node, priorJson string) (string, error)
• func CreateResource(logicalId string, resource *yaml.Node) (identifier string, model string, err error)
• func DeleteResource(logicalId string, identifier string, resource *yaml.Node) error
• func GetResource(identifier string, typeName string) (string, error)
• func ResourceExists(typeName string, identifier []string) bool
• func ToJsonProps(resource *yaml.Node) string
• func UpdateResource(logicalId string, identifier string, resource *yaml.Node, priorJson string) (model string, err error)

Functions

func CreatePatch

func CreatePatch(props *yaml.Node, priorJson string) (string, error)

Create a json patch document based on the new props and the prior json from the last version of the template (not the property model)

func CreateResource

func CreateResource(logicalId string, resource *yaml.Node) (identifier string, model string, err error)

CreateResource creates a resource based on the YAML node from the template, and blocks until resource creation is complete.

func DeleteResource

func DeleteResource(logicalId string, identifier string, resource *yaml.Node) error

DeleteResource deletes a resource and blocks until the operation is complete

func GetResource

func GetResource(identifier string, typeName string) (string, error)

GetResource gets a resource from cloud control api It returns the resource model as a string

func ResourceExists

func ResourceExists(typeName string, identifier []string) bool

Returns true if the resource already exists

func ToJsonProps

func ToJsonProps(resource *yaml.Node) string

toJsonProps converts properties in a resource node to the JSON representation

func UpdateResource

func UpdateResource(
	logicalId string,
	identifier string,
	resource *yaml.Node,
	priorJson string) (model string, err error)

UpdateResource updates a resource based on the YAML node from the template, and blocks until resource update is complete.